| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>RBush</name>
- </assembly>
- <members>
- <member name="M:RBush.ArgumentNullException.ThrowIfNull(System.Object,System.String)">
- <summary>Throws an <see cref="T:RBush.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
- <param name="argument">The reference type argument to validate as non-null.</param>
- <param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
- </member>
- <member name="T:RBush.Envelope">
- <summary>
- A bounding envelope, used to identify the bounds of of the points within
- a particular node.
- </summary>
- <param name="MinX">The minimum X value of the bounding box.</param>
- <param name="MinY">The minimum Y value of the bounding box.</param>
- <param name="MaxX">The maximum X value of the bounding box.</param>
- <param name="MaxY">The maximum Y value of the bounding box.</param>
- </member>
- <member name="M:RBush.Envelope.#ctor(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- A bounding envelope, used to identify the bounds of of the points within
- a particular node.
- </summary>
- <param name="MinX">The minimum X value of the bounding box.</param>
- <param name="MinY">The minimum Y value of the bounding box.</param>
- <param name="MaxX">The maximum X value of the bounding box.</param>
- <param name="MaxY">The maximum Y value of the bounding box.</param>
- </member>
- <member name="P:RBush.Envelope.MinX">
- <summary>The minimum X value of the bounding box.</summary>
- </member>
- <member name="P:RBush.Envelope.MinY">
- <summary>The minimum Y value of the bounding box.</summary>
- </member>
- <member name="P:RBush.Envelope.MaxX">
- <summary>The maximum X value of the bounding box.</summary>
- </member>
- <member name="P:RBush.Envelope.MaxY">
- <summary>The maximum Y value of the bounding box.</summary>
- </member>
- <member name="P:RBush.Envelope.Area">
- <summary>
- The calculated area of the bounding box.
- </summary>
- </member>
- <member name="P:RBush.Envelope.Margin">
- <summary>
- Half of the linear perimeter of the bounding box
- </summary>
- </member>
- <member name="M:RBush.Envelope.Extend(RBush.Envelope@)">
- <summary>
- Extends a bounding box to include another bounding box
- </summary>
- <param name="other">The other bounding box</param>
- <returns>A new bounding box that encloses both bounding boxes.</returns>
- <remarks>Does not affect the current bounding box.</remarks>
- </member>
- <member name="M:RBush.Envelope.Intersection(RBush.Envelope@)">
- <summary>
- Intersects a bounding box to only include the common area
- of both bounding boxes
- </summary>
- <param name="other">The other bounding box</param>
- <returns>A new bounding box that is the intersection of both bounding boxes.</returns>
- <remarks>Does not affect the current bounding box.</remarks>
- </member>
- <member name="M:RBush.Envelope.Contains(RBush.Envelope@)">
- <summary>
- Determines whether <paramref name="other"/> is contained
- within this bounding box.
- </summary>
- <param name="other">The other bounding box</param>
- <returns>
- <see langword="true" /> if <paramref name="other"/> is
- completely contained within this bounding box;
- <see langword="false" /> otherwise.
- </returns>
- </member>
- <member name="M:RBush.Envelope.Intersects(RBush.Envelope@)">
- <summary>
- Determines whether <paramref name="other"/> intersects
- this bounding box.
- </summary>
- <param name="other">The other bounding box</param>
- <returns>
- <see langword="true" /> if <paramref name="other"/> is
- intersects this bounding box in any way;
- <see langword="false" /> otherwise.
- </returns>
- </member>
- <member name="P:RBush.Envelope.InfiniteBounds">
- <summary>
- A bounding box that contains the entire 2-d plane.
- </summary>
- </member>
- <member name="P:RBush.Envelope.EmptyBounds">
- <summary>
- An empty bounding box.
- </summary>
- </member>
- <member name="T:RBush.ISpatialData">
- <summary>
- Exposes an <see cref="P:RBush.ISpatialData.Envelope"/> that describes the
- bounding box of current object.
- </summary>
- </member>
- <member name="P:RBush.ISpatialData.Envelope">
- <summary>
- The bounding box of the current object.
- </summary>
- </member>
- <member name="T:RBush.ISpatialDatabase`1">
- <summary>
- Provides the base interface for the abstraction for
- an updateable data store of elements on a 2-d plane.
- </summary>
- <typeparam name="T">The type of elements in the index.</typeparam>
- </member>
- <member name="M:RBush.ISpatialDatabase`1.Insert(`0)">
- <summary>
- Adds an object to the <see cref="T:RBush.ISpatialDatabase`1"/>
- </summary>
- <param name="item">
- The object to be added to <see cref="T:RBush.ISpatialDatabase`1"/>.
- </param>
- </member>
- <member name="M:RBush.ISpatialDatabase`1.Delete(`0)">
- <summary>
- Removes an object from the <see cref="T:RBush.ISpatialDatabase`1"/>.
- </summary>
- <param name="item">
- The object to be removed from the <see cref="T:RBush.ISpatialDatabase`1"/>.
- </param>
- <returns><see langword="bool" /> indicating whether the item was removed.</returns>
- </member>
- <member name="M:RBush.ISpatialDatabase`1.Clear">
- <summary>
- Removes all elements from the <see cref="T:RBush.ISpatialDatabase`1"/>.
- </summary>
- </member>
- <member name="M:RBush.ISpatialDatabase`1.BulkLoad(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Adds all of the elements from the collection to the <see cref="T:RBush.ISpatialDatabase`1"/>.
- </summary>
- <param name="items">
- A collection of items to add to the <see cref="T:RBush.ISpatialDatabase`1"/>.
- </param>
- <remarks>
- For multiple items, this method is more performant than
- adding items individually via <see cref="M:RBush.ISpatialDatabase`1.Insert(`0)"/>.
- </remarks>
- </member>
- <member name="T:RBush.ISpatialIndex`1">
- <summary>
- Provides the base interface for the abstraction of
- an index to find points within a bounding box.
- </summary>
- <typeparam name="T">The type of elements in the index.</typeparam>
- </member>
- <member name="M:RBush.ISpatialIndex`1.Search">
- <summary>
- Get all of the elements within the current <see cref="T:RBush.ISpatialIndex`1"/>.
- </summary>
- <returns>
- A list of every element contained in the <see cref="T:RBush.ISpatialIndex`1"/>.
- </returns>
- </member>
- <member name="M:RBush.ISpatialIndex`1.Search(RBush.Envelope@)">
- <summary>
- Get all of the elements from this <see cref="T:RBush.ISpatialIndex`1"/>
- within the <paramref name="boundingBox"/> bounding box.
- </summary>
- <param name="boundingBox">The area for which to find elements.</param>
- <returns>
- A list of the points that are within the bounding box
- from this <see cref="T:RBush.ISpatialIndex`1"/>.
- </returns>
- </member>
- <member name="T:RBush.RBush`1">
- <summary>
- An implementation of the R-tree data structure for 2-d spatial indexing.
- </summary>
- <typeparam name="T">The type of elements in the index.</typeparam>
- </member>
- <member name="P:RBush.RBush`1.Root">
- <summary>
- The root of the R-tree.
- </summary>
- </member>
- <member name="P:RBush.RBush`1.Envelope">
- <summary>
- The bounding box of all elements currently in the data structure.
- </summary>
- </member>
- <member name="M:RBush.RBush`1.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:RBush.RBush`1"/> that is
- empty and has the default tree width and default <see cref="T:System.Collections.Generic.IEqualityComparer`1"/>.
- </summary>
- </member>
- <member name="M:RBush.RBush`1.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:RBush.RBush`1"/> that is
- empty and has a custom max number of elements per tree node
- and default <see cref="T:System.Collections.Generic.IEqualityComparer`1"/>.
- </summary>
- <param name="maxEntries"></param>
- </member>
- <member name="M:RBush.RBush`1.#ctor(System.Int32,System.Collections.Generic.IEqualityComparer{`0})">
- <summary>
- Initializes a new instance of the <see cref="T:RBush.RBush`1"/> that is
- empty and has a custom max number of elements per tree node
- and a custom <see cref="T:System.Collections.Generic.IEqualityComparer`1"/>.
- </summary>
- <param name="maxEntries"></param>
- <param name="comparer"></param>
- </member>
- <member name="P:RBush.RBush`1.Count">
- <summary>
- Gets the number of items currently stored in the <see cref="T:RBush.RBush`1"/>
- </summary>
- </member>
- <member name="M:RBush.RBush`1.Clear">
- <summary>
- Removes all elements from the <see cref="T:RBush.RBush`1"/>.
- </summary>
- </member>
- <member name="M:RBush.RBush`1.Search">
- <summary>
- Get all of the elements within the current <see cref="T:RBush.RBush`1"/>.
- </summary>
- <returns>
- A list of every element contained in the <see cref="T:RBush.RBush`1"/>.
- </returns>
- </member>
- <member name="M:RBush.RBush`1.Search(RBush.Envelope@)">
- <summary>
- Get all of the elements from this <see cref="T:RBush.RBush`1"/>
- within the <paramref name="boundingBox"/> bounding box.
- </summary>
- <param name="boundingBox">The area for which to find elements.</param>
- <returns>
- A list of the points that are within the bounding box
- from this <see cref="T:RBush.RBush`1"/>.
- </returns>
- </member>
- <member name="M:RBush.RBush`1.Insert(`0)">
- <summary>
- Adds an object to the <see cref="T:RBush.RBush`1"/>
- </summary>
- <param name="item">
- The object to be added to <see cref="T:RBush.RBush`1"/>.
- </param>
- </member>
- <member name="M:RBush.RBush`1.BulkLoad(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Adds all of the elements from the collection to the <see cref="T:RBush.RBush`1"/>.
- </summary>
- <param name="items">
- A collection of items to add to the <see cref="T:RBush.RBush`1"/>.
- </param>
- <remarks>
- For multiple items, this method is more performant than
- adding items individually via <see cref="M:RBush.RBush`1.Insert(`0)"/>.
- </remarks>
- </member>
- <member name="M:RBush.RBush`1.Delete(`0)">
- <summary>
- Removes an object from the <see cref="T:RBush.RBush`1"/>.
- </summary>
- <param name="item">
- The object to be removed from the <see cref="T:RBush.RBush`1"/>.
- </param>
- <returns><see langword="bool" /> indicating whether the item was deleted.</returns>
- </member>
- <member name="T:RBush.RBush`1.Node">
- <summary>
- A node in an R-tree data structure containing other nodes
- or elements of type <typeparamref name="T"/>.
- </summary>
- </member>
- <member name="P:RBush.RBush`1.Node.Children">
- <summary>
- The descendent nodes or elements of a <see cref="T:RBush.RBush`1.Node"/>
- </summary>
- </member>
- <member name="P:RBush.RBush`1.Node.Height">
- <summary>
- The current height of a <see cref="T:RBush.RBush`1.Node"/>.
- </summary>
- <remarks>
- A node containing individual elements has a <see cref="P:RBush.RBush`1.Node.Height"/> of 1.
- </remarks>
- </member>
- <member name="P:RBush.RBush`1.Node.IsLeaf">
- <summary>
- Determines whether the current <see cref="T:RBush.RBush`1.Node"/> is a leaf node.
- </summary>
- </member>
- <member name="P:RBush.RBush`1.Node.Envelope">
- <summary>
- Gets the bounding box of all of the descendents of the
- current <see cref="T:RBush.RBush`1.Node"/>.
- </summary>
- </member>
- <member name="T:RBush.RBushExtensions">
- <summary>
- Extension methods for the <see cref="T:RBush.RBush`1"/> object.
- </summary>
- </member>
- <member name="M:RBush.RBushExtensions.Knn``1(RBush.ISpatialIndex{``0},System.Int32,System.Double,System.Double,System.Nullable{System.Double},System.Func{``0,System.Boolean})">
- <summary>
- Get the <paramref name="k"/> nearest neighbors to a specific point.
- </summary>
- <typeparam name="T">The type of elements in the index.</typeparam>
- <param name="tree">An index of points.</param>
- <param name="k">The number of points to retrieve.</param>
- <param name="x">The x-coordinate of the center point.</param>
- <param name="y">The y-coordinate of the center point.</param>
- <param name="maxDistance">The maximum distance of points to be considered "near"; optional.</param>
- <param name="predicate">A function to test each element for a condition; optional.</param>
- <returns>The list of up to <paramref name="k"/> elements nearest to the given point.</returns>
- </member>
- <member name="M:RBush.RBushExtensions.DistanceTo(RBush.Envelope@,System.Double,System.Double)">
- <summary>
- Calculates the distance from the borders of an <see cref="T:RBush.Envelope"/>
- to a given point.
- </summary>
- <param name="envelope">The <see cref="T:RBush.Envelope"/> from which to find the distance</param>
- <param name="x">The x-coordinate of the given point</param>
- <param name="y">The y-coordinate of the given point</param>
- <returns>The calculated Euclidean shortest distance from the <paramref name="envelope"/> to a given point.</returns>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
- <summary>
- Specifies that null is allowed as an input even if the corresponding type disallows it.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
- <summary>
- Specifies that null is disallowed as an input even if the corresponding type allows it.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
- <summary>
- Applied to a method that will never return under any circumstance.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
- <summary>
- Specifies that the method will not return if the associated Boolean parameter is passed the specified value.
- </summary>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
- <summary>
- Initializes the attribute with the specified parameter value.
- </summary>
- <param name="parameterValue">
- The condition parameter value. Code after the method will be considered unreachable
- by diagnostics if the argument to the associated parameter matches this value.
- </param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
- <summary>
- Gets the condition parameter value.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.ExperimentalAttribute">
- <summary>
- Indicates that an API is experimental and it may change in the future.
- </summary>
- <remarks>
- This attribute allows call sites to be flagged with a diagnostic that indicates that an experimental
- feature is used. Authors can use this attribute to ship preview features in their assemblies.
- </remarks>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.ExperimentalAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.ExperimentalAttribute"/> class,
- specifying the ID that the compiler will use when reporting a use of the API the attribute applies to.
- </summary>
- <param name="diagnosticId">The ID that the compiler will use when reporting a use of the API the attribute applies to.</param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.ExperimentalAttribute.DiagnosticId">
- <summary>
- Gets the ID that the compiler will use when reporting a use of the API the attribute applies to.
- </summary>
- <value>The unique diagnostic ID.</value>
- <remarks>
- The diagnostic ID is shown in build output for warnings and errors.
- <para>This property represents the unique ID that can be used to suppress the warnings or errors, if needed.</para>
- </remarks>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.ExperimentalAttribute.UrlFormat">
- <summary>
- Gets or sets the URL for corresponding documentation.
- The API accepts a format string instead of an actual URL, creating a generic URL that includes the diagnostic ID.
- </summary>
- <value>The format string that represents a URL to corresponding documentation.</value>
- <remarks>An example format string is <c>https://contoso.com/obsoletion-warnings/{0}</c>.</remarks>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
- <summary>
- Specifies that an output may be null even if the corresponding type disallows it.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
- <summary>
- Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.
- </summary>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
- <summary>
- Initializes the attribute with the specified return value condition.
- </summary>
- <param name="returnValue">The return value condition. If the method returns this value, the associated parameter may be null.</param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
- <summary>
- Gets the return value condition.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
- <summary>
- Specifies that the method or property will ensure that the listed field and property members have not-null values.
- </summary>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
- <summary>
- Initializes the attribute with a field or property member.
- </summary>
- <param name="member">The field or property member that is promised to be not-null.</param>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
- <summary>
- Initializes the attribute with the list of field and property members.
- </summary>
- <param name="members">The list of field and property members that are promised to be not-null.</param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
- <summary>
- Gets field or property member names.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
- <summary>
- Specifies that the method or property will ensure that the listed field and property
- members have not-null values when returning with the specified return value condition.
- </summary>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
- <summary>
- Initializes the attribute with the specified return value condition and a field or property member.
- </summary>
- <param name="returnValue">The return value condition. If the method returns this value, the associated parameter will not be null.</param>
- <param name="member">The field or property member that is promised to be not-null.</param>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
- <summary>
- Initializes the attribute with the specified return value condition and list of field and property members.
- </summary>
- <param name="returnValue">The return value condition. If the method returns this value, the associated parameter will not be null.</param>
- <param name="members">The list of field and property members that are promised to be not-null.</param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
- <summary>
- Gets the return value condition.
- </summary>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
- <summary>
- Gets field or property member names.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
- <summary>
- Specifies that an output will not be null even if the corresponding type allows it.
- Specifies that an input argument was not null when the call returns.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
- <summary>
- Specifies that the output will be non-null if the named parameter is non-null.
- </summary>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
- <summary>
- Initializes the attribute with the associated parameter name.
- </summary>
- <param name="parameterName">The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.</param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
- <summary>
- Gets the associated parameter name.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
- <summary>
- Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.
- </summary>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
- <summary>
- Initializes the attribute with the specified return value condition.
- </summary>
- <param name="returnValue">The return value condition. If the method returns this value, the associated parameter will not be null.</param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
- <summary>Gets the return value condition.</summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.SetsRequiredMembersAttribute">
- <summary>
- Specifies that this constructor sets all required members for the current type,
- and callers do not need to set any required members themselves.
- </summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute">
- <summary>
- Specifies the syntax used in a string.
- </summary>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.#ctor(System.String)">
- <summary>
- Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute"/> with the identifier of the syntax used.
- </summary>
- <param name="syntax">The syntax identifier.</param>
- </member>
- <member name="M:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.#ctor(System.String,System.Object[])">
- <summary>Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute"/> with the identifier of the syntax used.</summary>
- <param name="syntax">The syntax identifier.</param>
- <param name="arguments">Optional arguments associated with the specific syntax employed.</param>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Syntax">
- <summary>Gets the identifier of the syntax used.</summary>
- </member>
- <member name="P:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Arguments">
- <summary>Optional arguments associated with the specific syntax employed.</summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.CompositeFormat">
- <summary>The syntax identifier for strings containing composite formats for string formatting.</summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.DateOnlyFormat">
- <summary>The syntax identifier for strings containing date format specifiers.</summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.DateTimeFormat">
- <summary>The syntax identifier for strings containing date and time format specifiers.</summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.EnumFormat">
- <summary>The syntax identifier for strings containing <see cref="T:System.Enum"/> format specifiers.</summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat">
- <summary>The syntax identifier for strings containing <see cref="T:System.Guid"/> format specifiers.</summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Json">
- <summary>The syntax identifier for strings containing JavaScript Object Notation (JSON).</summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat">
- <summary>The syntax identifier for strings containing numeric format specifiers.</summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Regex">
- <summary>The syntax identifier for strings containing regular expressions.</summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.TimeOnlyFormat">
- <summary>The syntax identifier for strings containing time format specifiers.</summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.TimeSpanFormat">
- <summary>The syntax identifier for strings containing <see cref="T:System.TimeSpan"/> format specifiers.</summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Uri">
- <summary>The syntax identifier for strings containing URIs.</summary>
- </member>
- <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Xml">
- <summary>The syntax identifier for strings containing XML.</summary>
- </member>
- <member name="T:System.Diagnostics.CodeAnalysis.UnscopedRefAttribute">
- <summary>
- Used to indicate a byref escapes and is not scoped.
- </summary>
- <remarks>
- <para>
- There are several cases where the C# compiler treats a <see langword="ref"/> as implicitly
- <see langword="scoped"/> - where the compiler does not allow the <see langword="ref"/> to escape the method.
- </para>
- <para>
- For example:
- <list type="number">
- <item><see langword="this"/> for <see langword="struct"/> instance methods.</item>
- <item><see langword="ref"/> parameters that refer to <see langword="ref"/> <see langword="struct"/> types.</item>
- <item><see langword="out"/> parameters.</item>
- </list>
- </para>
- <para>
- This attribute is used in those instances where the <see langword="ref"/> should be allowed to escape.
- </para>
- <para>
- Applying this attribute, in any form, has impact on consumers of the applicable API. It is necessary for
- API authors to understand the lifetime implications of applying this attribute and how it may impact their users.
- </para>
- </remarks>
- </member>
- <member name="T:System.Index">
- <summary>Represent a type can be used to index a collection either from the start or the end.</summary>
- <remarks>
- Index is used by the C# compiler to support the new index syntax
- <code>
- int[] someArray = new int[5] { 1, 2, 3, 4, 5 } ;
- int lastElement = someArray[^1]; // lastElement = 5
- </code>
- </remarks>
- </member>
- <member name="M:System.Index.#ctor(System.Int32,System.Boolean)">
- <summary>Construct an Index using a value and indicating if the index is from the start or from the end.</summary>
- <param name="value">The index value. it has to be zero or positive number.</param>
- <param name="fromEnd">Indicating if the index is from the start or from the end.</param>
- <remarks>
- If the Index constructed from the end, index value 1 means pointing at the last element and index value 0 means pointing at beyond last element.
- </remarks>
- </member>
- <member name="P:System.Index.Start">
- <summary>Create an Index pointing at first element.</summary>
- </member>
- <member name="P:System.Index.End">
- <summary>Create an Index pointing at beyond last element.</summary>
- </member>
- <member name="M:System.Index.FromStart(System.Int32)">
- <summary>Create an Index from the start at the position indicated by the value.</summary>
- <param name="value">The index value from the start.</param>
- </member>
- <member name="M:System.Index.FromEnd(System.Int32)">
- <summary>Create an Index from the end at the position indicated by the value.</summary>
- <param name="value">The index value from the end.</param>
- </member>
- <member name="P:System.Index.Value">
- <summary>Returns the index value.</summary>
- </member>
- <member name="P:System.Index.IsFromEnd">
- <summary>Indicates whether the index is from the start or the end.</summary>
- </member>
- <member name="M:System.Index.GetOffset(System.Int32)">
- <summary>Calculate the offset from the start using the giving collection length.</summary>
- <param name="length">The length of the collection that the Index will be used with. length has to be a positive value</param>
- <remarks>
- For performance reason, we don't validate the input length parameter and the returned offset value against negative values.
- we don't validate either the returned offset is greater than the input length.
- It is expected Index will be used with collections which always have non negative length/count. If the returned offset is negative and
- then used to index a collection will get out of range exception which will be same affect as the validation.
- </remarks>
- </member>
- <member name="M:System.Index.Equals(System.Object)">
- <summary>Indicates whether the current Index object is equal to another object of the same type.</summary>
- <param name="value">An object to compare with this object</param>
- </member>
- <member name="M:System.Index.Equals(System.Index)">
- <summary>Indicates whether the current Index object is equal to another Index object.</summary>
- <param name="other">An object to compare with this object</param>
- </member>
- <member name="M:System.Index.GetHashCode">
- <summary>Returns the hash code for this instance.</summary>
- </member>
- <member name="M:System.Index.op_Implicit(System.Int32)~System.Index">
- <summary>Converts integer number to an Index.</summary>
- </member>
- <member name="M:System.Index.ToString">
- <summary>Converts the value of the current Index object to its equivalent string representation.</summary>
- </member>
- <member name="T:System.Range">
- <summary>Represent a range has start and end indexes.</summary>
- <remarks>
- Range is used by the C# compiler to support the range syntax.
- <code>
- int[] someArray = new int[5] { 1, 2, 3, 4, 5 };
- int[] subArray1 = someArray[0..2]; // { 1, 2 }
- int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 }
- </code>
- </remarks>
- </member>
- <member name="P:System.Range.Start">
- <summary>Represent the inclusive start index of the Range.</summary>
- </member>
- <member name="P:System.Range.End">
- <summary>Represent the exclusive end index of the Range.</summary>
- </member>
- <member name="M:System.Range.#ctor(System.Index,System.Index)">
- <summary>Construct a Range object using the start and end indexes.</summary>
- <param name="start">Represent the inclusive start index of the range.</param>
- <param name="end">Represent the exclusive end index of the range.</param>
- </member>
- <member name="M:System.Range.Equals(System.Object)">
- <summary>Indicates whether the current Range object is equal to another object of the same type.</summary>
- <param name="value">An object to compare with this object</param>
- </member>
- <member name="M:System.Range.Equals(System.Range)">
- <summary>Indicates whether the current Range object is equal to another Range object.</summary>
- <param name="other">An object to compare with this object</param>
- </member>
- <member name="M:System.Range.GetHashCode">
- <summary>Returns the hash code for this instance.</summary>
- </member>
- <member name="M:System.Range.ToString">
- <summary>Converts the value of the current Range object to its equivalent string representation.</summary>
- </member>
- <member name="M:System.Range.StartAt(System.Index)">
- <summary>Create a Range object starting from start index to the end of the collection.</summary>
- </member>
- <member name="M:System.Range.EndAt(System.Index)">
- <summary>Create a Range object starting from first element in the collection to the end Index.</summary>
- </member>
- <member name="P:System.Range.All">
- <summary>Create a Range object starting from first element to the end.</summary>
- </member>
- <member name="M:System.Range.GetOffsetAndLength(System.Int32)">
- <summary>Calculate the start offset and length of range object using a collection length.</summary>
- <param name="length">The length of the collection that the range will be used with. length has to be a positive value.</param>
- <remarks>
- For performance reason, we don't validate the input length parameter against negative values.
- It is expected Range will be used with collections which always have non negative length/count.
- We validate the range is inside the length scope though.
- </remarks>
- </member>
- <member name="T:System.Runtime.CompilerServices.AsyncMethodBuilderAttribute">
- <summary>
- Indicates the type of the async method builder that should be used by a language compiler to
- build the attributed async method or to build the attributed type when used as the return type
- of an async method.
- </summary>
- </member>
- <member name="M:System.Runtime.CompilerServices.AsyncMethodBuilderAttribute.#ctor(System.Type)">
- <summary>Initializes the <see cref="T:System.Runtime.CompilerServices.AsyncMethodBuilderAttribute"/>.</summary>
- <param name="builderType">The <see cref="T:System.Type"/> of the associated builder.</param>
- </member>
- <member name="P:System.Runtime.CompilerServices.AsyncMethodBuilderAttribute.BuilderType">
- <summary>Gets the <see cref="T:System.Type"/> of the associated builder.</summary>
- </member>
- <member name="T:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute">
- <summary>
- An attribute that allows parameters to receive the expression of other parameters.
- </summary>
- </member>
- <member name="M:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute"/> class.
- </summary>
- <param name="parameterName">The condition parameter value.</param>
- </member>
- <member name="P:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute.ParameterName">
- <summary>
- Gets the parameter name the expression is retrieved from.
- </summary>
- </member>
- <member name="M:System.Runtime.CompilerServices.CollectionBuilderAttribute.#ctor(System.Type,System.String)">
- <summary>
- Initialize the attribute to refer to the <paramref name="methodName"/> method on the <paramref name="builderType"/> type.
- </summary>
- <param name="builderType">The type of the builder to use to construct the collection.</param>
- <param name="methodName">The name of the method on the builder to use to construct the collection.</param>
- <remarks>
- <paramref name="methodName"/> must refer to a static method that accepts a single parameter of
- type <see cref="!:ReadOnlySpan<T>"/> and returns an instance of the collection being built containing
- a copy of the data from that span. In future releases of .NET, additional patterns may be supported.
- </remarks>
- </member>
- <member name="P:System.Runtime.CompilerServices.CollectionBuilderAttribute.BuilderType">
- <summary>
- Gets the type of the builder to use to construct the collection.
- </summary>
- </member>
- <member name="P:System.Runtime.CompilerServices.CollectionBuilderAttribute.MethodName">
- <summary>
- Gets the name of the method on the builder to use to construct the collection.
- </summary>
- <remarks>
- This should match the metadata name of the target method.
- For example, this might be ".ctor" if targeting the type's constructor.
- </remarks>
- </member>
- <member name="T:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute">
- <summary>
- Indicates that compiler support for a particular feature is required for the location where this attribute is applied.
- </summary>
- </member>
- <member name="M:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.#ctor(System.String)">
- <summary>
- Creates a new instance of the <see cref="T:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute"/> type.
- </summary>
- <param name="featureName">The name of the feature to indicate.</param>
- </member>
- <member name="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName">
- <summary>
- The name of the compiler feature.
- </summary>
- </member>
- <member name="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.IsOptional">
- <summary>
- If true, the compiler can choose to allow access to the location where this attribute is applied if it does not understand <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/>.
- </summary>
- </member>
- <member name="F:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.RefStructs">
- <summary>
- The <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/> used for the ref structs C# feature.
- </summary>
- </member>
- <member name="F:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.RequiredMembers">
- <summary>
- The <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/> used for the required members C# feature.
- </summary>
- </member>
- <member name="T:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute">
- <summary>
- Indicates which arguments to a method involving an interpolated string handler should be passed to that handler.
- </summary>
- </member>
- <member name="M:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute"/> class.
- </summary>
- <param name="argument">The name of the argument that should be passed to the handler.</param>
- <remarks><see langword="null"/> may be used as the name of the receiver in an instance method.</remarks>
- </member>
- <member name="M:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute.#ctor(System.String[])">
- <summary>
- Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute"/> class.
- </summary>
- <param name="arguments">The names of the arguments that should be passed to the handler.</param>
- <remarks><see langword="null"/> may be used as the name of the receiver in an instance method.</remarks>
- </member>
- <member name="P:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute.Arguments">
- <summary>
- Gets the names of the arguments that should be passed to the handler.
- </summary>
- <remarks><see langword="null"/> may be used as the name of the receiver in an instance method.</remarks>
- </member>
- <member name="T:System.Runtime.CompilerServices.InterpolatedStringHandlerAttribute">
- <summary>
- Indicates the attributed type is to be used as an interpolated string handler.
- </summary>
- </member>
- <member name="T:System.Runtime.CompilerServices.IsExternalInit">
- <summary>
- Reserved to be used by the compiler for tracking metadata.
- This class should not be used by developers in source code.
- </summary>
- </member>
- <member name="T:System.Runtime.CompilerServices.ModuleInitializerAttribute">
- <summary>
- Used to indicate to the compiler that a method should be called
- in its containing module's initializer.
- </summary>
- <remarks>
- When one or more valid methods
- with this attribute are found in a compilation, the compiler will
- emit a module initializer which calls each of the attributed methods.
-
- Certain requirements are imposed on any method targeted with this attribute:
- - The method must be `static`.
- - The method must be an ordinary member method, as opposed to a property accessor, constructor, local function, etc.
- - The method must be parameterless.
- - The method must return `void`.
- - The method must not be generic or be contained in a generic type.
- - The method's effective accessibility must be `internal` or `public`.
-
- The specification for module initializers in the .NET runtime can be found here:
- https://github.com/dotnet/runtime/blob/main/docs/design/specs/Ecma-335-Augments.md#module-initializer
- </remarks>
- </member>
- <member name="T:System.Runtime.CompilerServices.RequiredMemberAttribute">
- <summary>
- Specifies that a type has required members or that a member is required.
- </summary>
- </member>
- <member name="T:System.Runtime.CompilerServices.RequiresLocationAttribute">
- <summary>
- Reserved for use by a compiler for tracking metadata.
- This attribute should not be used by developers in source code.
- </summary>
- </member>
- <member name="T:System.Runtime.CompilerServices.SkipLocalsInitAttribute">
- <summary>
- Used to indicate to the compiler that the <c>.locals init</c> flag should not be set in method headers.
- </summary>
- </member>
- <member name="M:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute"/> class.
- </summary>
- </member>
- <member name="M:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute"/> class with the specified message.
- </summary>
- <param name="message">An optional message associated with this attribute instance.</param>
- </member>
- <member name="P:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.Message">
- <summary>
- Returns the optional message associated with this attribute instance.
- </summary>
- </member>
- <member name="P:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.Url">
- <summary>
- Returns the optional URL associated with this attribute instance.
- </summary>
- </member>
- </members>
- </doc>
|