diff --git a/api-reference/9.0/PolylineAlgorithm.Abstraction.AbstractPolylineDecoder-2.yml b/api-reference/9.0/PolylineAlgorithm.Abstraction.AbstractPolylineDecoder-2.yml new file mode 100644 index 00000000..c69bfe08 --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.Abstraction.AbstractPolylineDecoder-2.yml @@ -0,0 +1,190 @@ +### YamlMime:ApiPage +title: Class AbstractPolylineDecoder +body: +- api1: Class AbstractPolylineDecoder + id: PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2 + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/AbstractPolylineDecoder.cs#L23 + metadata: + uid: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2 + commentId: T:PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2 +- facts: + - name: Namespace + value: + text: PolylineAlgorithm.Abstraction + url: PolylineAlgorithm.Abstraction.html + - name: Assembly + value: PolylineAlgorithm.dll +- markdown: >- + Decodes encoded polyline strings into sequences of geographic coordinates. + + Implements the interface. +- code: 'public abstract class AbstractPolylineDecoder : IPolylineDecoder' +- h4: Type Parameters +- parameters: + - name: TPolyline + - name: TCoordinate +- h4: Inheritance +- inheritance: + - text: object + url: https://learn.microsoft.com/dotnet/api/system.object + - text: AbstractPolylineDecoder + url: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder-2.html +- h4: Implements +- list: + - text: IPolylineDecoder + url: PolylineAlgorithm.Abstraction.IPolylineDecoder-2.html +- h4: Inherited Members +- list: + - text: object.Equals(object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object) + - text: object.Equals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object) + - text: object.GetHashCode() + url: https://learn.microsoft.com/dotnet/api/system.object.gethashcode + - text: object.GetType() + url: https://learn.microsoft.com/dotnet/api/system.object.gettype + - text: object.MemberwiseClone() + url: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone + - text: object.ReferenceEquals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.referenceequals + - text: object.ToString() + url: https://learn.microsoft.com/dotnet/api/system.object.tostring +- h2: Remarks +- markdown: This abstract class provides a base implementation for decoding polylines, allowing subclasses to define how to handle specific polyline formats. +- h2: Constructors +- api3: AbstractPolylineDecoder() + id: PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2__ctor + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/AbstractPolylineDecoder.cs#L27 + metadata: + uid: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.#ctor + commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.#ctor +- markdown: Initializes a new instance of the class with default encoding options. +- code: protected AbstractPolylineDecoder() +- api3: AbstractPolylineDecoder(PolylineEncodingOptions) + id: PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2__ctor_PolylineAlgorithm_PolylineEncodingOptions_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/AbstractPolylineDecoder.cs#L39 + metadata: + uid: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.#ctor(PolylineAlgorithm.PolylineEncodingOptions) + commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.#ctor(PolylineAlgorithm.PolylineEncodingOptions) +- markdown: Initializes a new instance of the class with the specified encoding options. +- code: protected AbstractPolylineDecoder(PolylineEncodingOptions options) +- h4: Parameters +- parameters: + - name: options + type: + - text: PolylineEncodingOptions + url: PolylineAlgorithm.PolylineEncodingOptions.html + description: The to use for encoding operations. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentNullException + url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception + description: Thrown when options is null +- h2: Properties +- api3: Options + id: PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2_Options + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/AbstractPolylineDecoder.cs#L46 + metadata: + uid: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.Options + commentId: P:PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.Options +- markdown: Gets the encoding options used by this polyline encoder. +- code: public PolylineEncodingOptions Options { get; } +- h4: Property Value +- parameters: + - type: + - text: PolylineEncodingOptions + url: PolylineAlgorithm.PolylineEncodingOptions.html +- h2: Methods +- api3: CreateCoordinate(double, double) + id: PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2_CreateCoordinate_System_Double_System_Double_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/AbstractPolylineDecoder.cs#L153 + metadata: + uid: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.CreateCoordinate(System.Double,System.Double) + commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.CreateCoordinate(System.Double,System.Double) +- markdown: Creates a coordinate instance from the given latitude and longitude values. +- code: protected abstract TCoordinate CreateCoordinate(double latitude, double longitude) +- h4: Parameters +- parameters: + - name: latitude + type: + - text: double + url: https://learn.microsoft.com/dotnet/api/system.double + description: The latitude value. + - name: longitude + type: + - text: double + url: https://learn.microsoft.com/dotnet/api/system.double + description: The longitude value. +- h4: Returns +- parameters: + - type: + - TCoordinate + description: A coordinate instance of type TCoordinate. +- api3: Decode(TPolyline) + id: PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2_Decode__0_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/AbstractPolylineDecoder.cs#L66 + metadata: + uid: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.Decode(`0) + commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.Decode(`0) +- markdown: Decodes an encoded TPolyline into a sequence of TCoordinate instances. +- code: public IEnumerable Decode(TPolyline polyline) +- h4: Parameters +- parameters: + - name: polyline + type: + - TPolyline + description: The TPolyline instance containing the encoded polyline string to decode. +- h4: Returns +- parameters: + - type: + - text: IEnumerable + url: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1 + - < + - TCoordinate + - '>' + description: An of TCoordinate representing the decoded latitude and longitude pairs. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentNullException + url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception + description: Thrown when polyline is null. + - type: + - text: ArgumentException + url: https://learn.microsoft.com/dotnet/api/system.argumentexception + description: Thrown when polyline is empty. + - type: + - text: InvalidPolylineException + url: PolylineAlgorithm.InvalidPolylineException.html + description: Thrown when the polyline format is invalid or malformed at a specific position. +- api3: GetReadOnlyMemory(TPolyline) + id: PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2_GetReadOnlyMemory__0_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/AbstractPolylineDecoder.cs#L139 + metadata: + uid: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.GetReadOnlyMemory(`0) + commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.GetReadOnlyMemory(`0) +- markdown: Converts the provided polyline instance into a for decoding. +- code: protected abstract ReadOnlyMemory GetReadOnlyMemory(TPolyline polyline) +- h4: Parameters +- parameters: + - name: polyline + type: + - TPolyline + description: The TPolyline instance containing the encoded polyline data to decode. +- h4: Returns +- parameters: + - type: + - text: ReadOnlyMemory + url: https://learn.microsoft.com/dotnet/api/system.readonlymemory-1 + - < + - text: char + url: https://learn.microsoft.com/dotnet/api/system.char + - '>' + description: A representing the encoded polyline data. +languageId: csharp +metadata: + description: >- + Decodes encoded polyline strings into sequences of geographic coordinates. + + Implements the interface. diff --git a/api-reference/9.0/PolylineAlgorithm.Abstraction.AbstractPolylineEncoder-2.yml b/api-reference/9.0/PolylineAlgorithm.Abstraction.AbstractPolylineEncoder-2.yml new file mode 100644 index 00000000..fd2de8c7 --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.Abstraction.AbstractPolylineEncoder-2.yml @@ -0,0 +1,204 @@ +### YamlMime:ApiPage +title: Class AbstractPolylineEncoder +body: +- api1: Class AbstractPolylineEncoder + id: PolylineAlgorithm_Abstraction_AbstractPolylineEncoder_2 + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/AbstractPolylineEncoder.cs#L25 + metadata: + uid: PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2 + commentId: T:PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2 +- facts: + - name: Namespace + value: + text: PolylineAlgorithm.Abstraction + url: PolylineAlgorithm.Abstraction.html + - name: Assembly + value: PolylineAlgorithm.dll +- markdown: >- + Provides functionality to encode a collection of geographic coordinates into an encoded polyline string. + + Implements the interface. +- code: 'public abstract class AbstractPolylineEncoder : IPolylineEncoder' +- h4: Type Parameters +- parameters: + - name: TCoordinate + - name: TPolyline +- h4: Inheritance +- inheritance: + - text: object + url: https://learn.microsoft.com/dotnet/api/system.object + - text: AbstractPolylineEncoder + url: PolylineAlgorithm.Abstraction.AbstractPolylineEncoder-2.html +- h4: Implements +- list: + - text: IPolylineEncoder + url: PolylineAlgorithm.Abstraction.IPolylineEncoder-2.html +- h4: Inherited Members +- list: + - text: object.Equals(object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object) + - text: object.Equals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object) + - text: object.GetHashCode() + url: https://learn.microsoft.com/dotnet/api/system.object.gethashcode + - text: object.GetType() + url: https://learn.microsoft.com/dotnet/api/system.object.gettype + - text: object.MemberwiseClone() + url: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone + - text: object.ReferenceEquals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.referenceequals + - text: object.ToString() + url: https://learn.microsoft.com/dotnet/api/system.object.tostring +- h2: Remarks +- markdown: This abstract class serves as a base for specific polyline encoders, allowing customization of the encoding process. +- h2: Constructors +- api3: AbstractPolylineEncoder() + id: PolylineAlgorithm_Abstraction_AbstractPolylineEncoder_2__ctor + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/AbstractPolylineEncoder.cs#L29 + metadata: + uid: PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2.#ctor + commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2.#ctor +- markdown: Initializes a new instance of the class with default encoding options. +- code: protected AbstractPolylineEncoder() +- api3: AbstractPolylineEncoder(PolylineEncodingOptions) + id: PolylineAlgorithm_Abstraction_AbstractPolylineEncoder_2__ctor_PolylineAlgorithm_PolylineEncodingOptions_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/AbstractPolylineEncoder.cs#L39 + metadata: + uid: PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2.#ctor(PolylineAlgorithm.PolylineEncodingOptions) + commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2.#ctor(PolylineAlgorithm.PolylineEncodingOptions) +- markdown: Initializes a new instance of the class with the specified encoding options. +- code: protected AbstractPolylineEncoder(PolylineEncodingOptions options) +- h4: Parameters +- parameters: + - name: options + type: + - text: PolylineEncodingOptions + url: PolylineAlgorithm.PolylineEncodingOptions.html + description: The to use for encoding operations. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentNullException + url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception + description: Thrown when options is null +- h2: Properties +- api3: Options + id: PolylineAlgorithm_Abstraction_AbstractPolylineEncoder_2_Options + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/AbstractPolylineEncoder.cs#L46 + metadata: + uid: PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2.Options + commentId: P:PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2.Options +- markdown: Gets the encoding options used by this polyline encoder. +- code: public PolylineEncodingOptions Options { get; } +- h4: Property Value +- parameters: + - type: + - text: PolylineEncodingOptions + url: PolylineAlgorithm.PolylineEncodingOptions.html +- h2: Methods +- api3: CreatePolyline(ReadOnlyMemory) + id: PolylineAlgorithm_Abstraction_AbstractPolylineEncoder_2_CreatePolyline_System_ReadOnlyMemory_System_Char__ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/AbstractPolylineEncoder.cs#L199 + metadata: + uid: PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2.CreatePolyline(System.ReadOnlyMemory{System.Char}) + commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2.CreatePolyline(System.ReadOnlyMemory{System.Char}) +- markdown: Creates a polyline instance from the provided read-only sequence of characters. +- code: protected abstract TPolyline CreatePolyline(ReadOnlyMemory polyline) +- h4: Parameters +- parameters: + - name: polyline + type: + - text: ReadOnlyMemory + url: https://learn.microsoft.com/dotnet/api/system.readonlymemory-1 + - < + - text: char + url: https://learn.microsoft.com/dotnet/api/system.char + - '>' + description: A containing the encoded polyline characters. +- h4: Returns +- parameters: + - type: + - TPolyline + description: An instance of TPolyline representing the encoded polyline. +- api3: Encode(IEnumerable) + id: PolylineAlgorithm_Abstraction_AbstractPolylineEncoder_2_Encode_System_Collections_Generic_IEnumerable__0__ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/AbstractPolylineEncoder.cs#L64 + metadata: + uid: PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2.Encode(System.Collections.Generic.IEnumerable{`0}) + commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2.Encode(System.Collections.Generic.IEnumerable{`0}) +- markdown: Encodes a collection of TCoordinate instances into an encoded TPolyline string. +- code: public TPolyline Encode(IEnumerable coordinates) +- h4: Parameters +- parameters: + - name: coordinates + type: + - text: IEnumerable + url: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1 + - < + - TCoordinate + - '>' + description: The collection of TCoordinate objects to encode. +- h4: Returns +- parameters: + - type: + - TPolyline + description: >- + An instance of TPolyline representing the encoded coordinates. + + Returns default if the input collection is empty or null. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentNullException + url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception + description: Thrown when coordinates is null. + - type: + - text: ArgumentException + url: https://learn.microsoft.com/dotnet/api/system.argumentexception + description: Thrown when coordinates is an empty enumeration. +- api3: GetLatitude(TCoordinate) + id: PolylineAlgorithm_Abstraction_AbstractPolylineEncoder_2_GetLatitude__0_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/AbstractPolylineEncoder.cs#L219 + metadata: + uid: PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2.GetLatitude(`0) + commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2.GetLatitude(`0) +- markdown: Extracts the latitude value from the specified coordinate. +- code: protected abstract double GetLatitude(TCoordinate current) +- h4: Parameters +- parameters: + - name: current + type: + - TCoordinate + description: The coordinate from which to extract the latitude. +- h4: Returns +- parameters: + - type: + - text: double + url: https://learn.microsoft.com/dotnet/api/system.double + description: The latitude value as a . +- api3: GetLongitude(TCoordinate) + id: PolylineAlgorithm_Abstraction_AbstractPolylineEncoder_2_GetLongitude__0_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/AbstractPolylineEncoder.cs#L209 + metadata: + uid: PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2.GetLongitude(`0) + commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineEncoder`2.GetLongitude(`0) +- markdown: Extracts the longitude value from the specified coordinate. +- code: protected abstract double GetLongitude(TCoordinate current) +- h4: Parameters +- parameters: + - name: current + type: + - TCoordinate + description: The coordinate from which to extract the longitude. +- h4: Returns +- parameters: + - type: + - text: double + url: https://learn.microsoft.com/dotnet/api/system.double + description: The longitude value as a . +languageId: csharp +metadata: + description: >- + Provides functionality to encode a collection of geographic coordinates into an encoded polyline string. + + Implements the interface. diff --git a/api-reference/9.0/PolylineAlgorithm.Abstraction.IPolylineDecoder-2.yml b/api-reference/9.0/PolylineAlgorithm.Abstraction.IPolylineDecoder-2.yml new file mode 100644 index 00000000..c5e72608 --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.Abstraction.IPolylineDecoder-2.yml @@ -0,0 +1,49 @@ +### YamlMime:ApiPage +title: Interface IPolylineDecoder +body: +- api1: Interface IPolylineDecoder + id: PolylineAlgorithm_Abstraction_IPolylineDecoder_2 + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/IPolylineDecoder.cs#L13 + metadata: + uid: PolylineAlgorithm.Abstraction.IPolylineDecoder`2 + commentId: T:PolylineAlgorithm.Abstraction.IPolylineDecoder`2 +- facts: + - name: Namespace + value: + text: PolylineAlgorithm.Abstraction + url: PolylineAlgorithm.Abstraction.html + - name: Assembly + value: PolylineAlgorithm.dll +- markdown: Defines a contract for decoding an encoded polyline into a sequence of geographic coordinates. +- code: public interface IPolylineDecoder +- h4: Type Parameters +- parameters: + - name: TPolyline + - name: TCoordinate +- h2: Methods +- api3: Decode(TPolyline) + id: PolylineAlgorithm_Abstraction_IPolylineDecoder_2_Decode__0_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/IPolylineDecoder.cs#L23 + metadata: + uid: PolylineAlgorithm.Abstraction.IPolylineDecoder`2.Decode(`0) + commentId: M:PolylineAlgorithm.Abstraction.IPolylineDecoder`2.Decode(`0) +- markdown: Decodes the specified encoded polyline into a sequence of geographic coordinates. +- code: IEnumerable Decode(TPolyline polyline) +- h4: Parameters +- parameters: + - name: polyline + type: + - TPolyline + description: The TPolyline instance containing the encoded polyline string to decode. +- h4: Returns +- parameters: + - type: + - text: IEnumerable + url: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1 + - < + - TCoordinate + - '>' + description: An of TCoordinate representing the decoded latitude and longitude pairs. +languageId: csharp +metadata: + description: Defines a contract for decoding an encoded polyline into a sequence of geographic coordinates. diff --git a/api-reference/9.0/PolylineAlgorithm.Abstraction.IPolylineEncoder-2.yml b/api-reference/9.0/PolylineAlgorithm.Abstraction.IPolylineEncoder-2.yml new file mode 100644 index 00000000..1be20562 --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.Abstraction.IPolylineEncoder-2.yml @@ -0,0 +1,49 @@ +### YamlMime:ApiPage +title: Interface IPolylineEncoder +body: +- api1: Interface IPolylineEncoder + id: PolylineAlgorithm_Abstraction_IPolylineEncoder_2 + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/IPolylineEncoder.cs#L13 + metadata: + uid: PolylineAlgorithm.Abstraction.IPolylineEncoder`2 + commentId: T:PolylineAlgorithm.Abstraction.IPolylineEncoder`2 +- facts: + - name: Namespace + value: + text: PolylineAlgorithm.Abstraction + url: PolylineAlgorithm.Abstraction.html + - name: Assembly + value: PolylineAlgorithm.dll +- markdown: Defines a contract for encoding a sequence of geographic coordinates into an encoded polyline string. +- code: public interface IPolylineEncoder +- h4: Type Parameters +- parameters: + - name: TCoordinate + - name: TPolyline +- h2: Methods +- api3: Encode(IEnumerable) + id: PolylineAlgorithm_Abstraction_IPolylineEncoder_2_Encode_System_Collections_Generic_IEnumerable__0__ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Abstraction/IPolylineEncoder.cs#L23 + metadata: + uid: PolylineAlgorithm.Abstraction.IPolylineEncoder`2.Encode(System.Collections.Generic.IEnumerable{`0}) + commentId: M:PolylineAlgorithm.Abstraction.IPolylineEncoder`2.Encode(System.Collections.Generic.IEnumerable{`0}) +- markdown: Encodes a sequence of geographic coordinates into an encoded polyline representation. +- code: TPolyline Encode(IEnumerable coordinates) +- h4: Parameters +- parameters: + - name: coordinates + type: + - text: IEnumerable + url: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1 + - < + - TCoordinate + - '>' + description: The collection of TCoordinate instances to encode into a polyline. +- h4: Returns +- parameters: + - type: + - TPolyline + description: A TPolyline containing the encoded polyline string that represents the input coordinates. +languageId: csharp +metadata: + description: Defines a contract for encoding a sequence of geographic coordinates into an encoded polyline string. diff --git a/api-reference/9.0/PolylineAlgorithm.Abstraction.yml b/api-reference/9.0/PolylineAlgorithm.Abstraction.yml new file mode 100644 index 00000000..ff580e3c --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.Abstraction.yml @@ -0,0 +1,35 @@ +### YamlMime:ApiPage +title: Namespace PolylineAlgorithm.Abstraction +body: +- api1: Namespace PolylineAlgorithm.Abstraction + id: PolylineAlgorithm_Abstraction + metadata: + uid: PolylineAlgorithm.Abstraction + commentId: N:PolylineAlgorithm.Abstraction +- h3: Classes +- parameters: + - type: + text: AbstractPolylineDecoder + url: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder-2.html + description: >- + Decodes encoded polyline strings into sequences of geographic coordinates. + + Implements the interface. + - type: + text: AbstractPolylineEncoder + url: PolylineAlgorithm.Abstraction.AbstractPolylineEncoder-2.html + description: >- + Provides functionality to encode a collection of geographic coordinates into an encoded polyline string. + + Implements the interface. +- h3: Interfaces +- parameters: + - type: + text: IPolylineDecoder + url: PolylineAlgorithm.Abstraction.IPolylineDecoder-2.html + description: Defines a contract for decoding an encoded polyline into a sequence of geographic coordinates. + - type: + text: IPolylineEncoder + url: PolylineAlgorithm.Abstraction.IPolylineEncoder-2.html + description: Defines a contract for encoding a sequence of geographic coordinates into an encoded polyline string. +languageId: csharp diff --git a/api-reference/9.0/PolylineAlgorithm.Coordinate.yml b/api-reference/9.0/PolylineAlgorithm.Coordinate.yml new file mode 100644 index 00000000..c6343ff3 --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.Coordinate.yml @@ -0,0 +1,250 @@ +### YamlMime:ApiPage +title: Struct Coordinate +body: +- api1: Struct Coordinate + id: PolylineAlgorithm_Coordinate + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Coordinate.cs#L22 + metadata: + uid: PolylineAlgorithm.Coordinate + commentId: T:PolylineAlgorithm.Coordinate +- facts: + - name: Namespace + value: + text: PolylineAlgorithm + url: PolylineAlgorithm.html + - name: Assembly + value: PolylineAlgorithm.dll +- markdown: Represents a geographic coordinate as a pair of latitude and longitude values. +- code: 'public readonly struct Coordinate : IEquatable' +- h4: Implements +- list: + - text: IEquatable + url: https://learn.microsoft.com/dotnet/api/system.iequatable-1 +- h4: Inherited Members +- list: + - text: object.Equals(object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object) + - text: object.Equals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object) + - text: object.GetHashCode() + url: https://learn.microsoft.com/dotnet/api/system.object.gethashcode + - text: object.GetType() + url: https://learn.microsoft.com/dotnet/api/system.object.gettype + - text: object.ReferenceEquals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.referenceequals + - text: object.ToString() + url: https://learn.microsoft.com/dotnet/api/system.object.tostring +- h2: Remarks +- markdown: >- + This struct is designed to be immutable and lightweight, providing a simple way to represent + + geographic coordinates in degrees. It includes validation for latitude and longitude ranges + + and provides methods for equality comparison and string representation. +- h2: Constructors +- api3: Coordinate() + id: PolylineAlgorithm_Coordinate__ctor + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Coordinate.cs#L28 + metadata: + uid: PolylineAlgorithm.Coordinate.#ctor + commentId: M:PolylineAlgorithm.Coordinate.#ctor +- markdown: Initializes a new instance of the struct with default values (0) for and . +- code: public Coordinate() +- api3: Coordinate(double, double) + id: PolylineAlgorithm_Coordinate__ctor_System_Double_System_Double_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Coordinate.cs#L46 + metadata: + uid: PolylineAlgorithm.Coordinate.#ctor(System.Double,System.Double) + commentId: M:PolylineAlgorithm.Coordinate.#ctor(System.Double,System.Double) +- markdown: Initializes a new instance of the struct with the specified latitude and longitude values. +- code: public Coordinate(double latitude, double longitude) +- h4: Parameters +- parameters: + - name: latitude + type: + - text: double + url: https://learn.microsoft.com/dotnet/api/system.double + description: The latitude component of the coordinate, in degrees. Must be between -90 and 90. + - name: longitude + type: + - text: double + url: https://learn.microsoft.com/dotnet/api/system.double + description: The longitude component of the coordinate, in degrees. Must be between -180 and 180. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentOutOfRangeException + url: https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception + description: >- + Thrown when latitude is less than -90 or greater than 90, + + or when longitude is less than -180 or greater than 180. +- h2: Properties +- api3: Latitude + id: PolylineAlgorithm_Coordinate_Latitude + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Coordinate.cs#L62 + metadata: + uid: PolylineAlgorithm.Coordinate.Latitude + commentId: P:PolylineAlgorithm.Coordinate.Latitude +- markdown: Gets the latitude component of the coordinate, in degrees. +- code: public double Latitude { get; } +- h4: Property Value +- parameters: + - type: + - text: double + url: https://learn.microsoft.com/dotnet/api/system.double +- api3: Longitude + id: PolylineAlgorithm_Coordinate_Longitude + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Coordinate.cs#L67 + metadata: + uid: PolylineAlgorithm.Coordinate.Longitude + commentId: P:PolylineAlgorithm.Coordinate.Longitude +- markdown: Gets the longitude component of the coordinate, in degrees. +- code: public double Longitude { get; } +- h4: Property Value +- parameters: + - type: + - text: double + url: https://learn.microsoft.com/dotnet/api/system.double +- h2: Methods +- api3: Equals(object?) + id: PolylineAlgorithm_Coordinate_Equals_System_Object_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Coordinate.cs#L82 + metadata: + uid: PolylineAlgorithm.Coordinate.Equals(System.Object) + commentId: M:PolylineAlgorithm.Coordinate.Equals(System.Object) +- markdown: Indicates whether this instance and a specified object are equal. +- code: public override bool Equals(object? obj) +- h4: Parameters +- parameters: + - name: obj + type: + - text: object + url: https://learn.microsoft.com/dotnet/api/system.object + - '?' + description: The object to compare with the current instance. +- h4: Returns +- parameters: + - type: + - text: bool + url: https://learn.microsoft.com/dotnet/api/system.boolean + description: true if obj and this instance are the same type and represent the same value; otherwise, false. +- api3: Equals(Coordinate) + id: PolylineAlgorithm_Coordinate_Equals_PolylineAlgorithm_Coordinate_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Coordinate.cs#L102 + metadata: + uid: PolylineAlgorithm.Coordinate.Equals(PolylineAlgorithm.Coordinate) + commentId: M:PolylineAlgorithm.Coordinate.Equals(PolylineAlgorithm.Coordinate) +- markdown: Indicates whether the current object is equal to another object of the same type. +- code: public bool Equals(Coordinate other) +- h4: Parameters +- parameters: + - name: other + type: + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + description: An object to compare with this object. +- h4: Returns +- parameters: + - type: + - text: bool + url: https://learn.microsoft.com/dotnet/api/system.boolean + description: true if the current object is equal to the other parameter; otherwise, false. +- api3: GetHashCode() + id: PolylineAlgorithm_Coordinate_GetHashCode + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Coordinate.cs#L85 + metadata: + uid: PolylineAlgorithm.Coordinate.GetHashCode + commentId: M:PolylineAlgorithm.Coordinate.GetHashCode +- markdown: Returns the hash code for this instance. +- code: public override int GetHashCode() +- h4: Returns +- parameters: + - type: + - text: int + url: https://learn.microsoft.com/dotnet/api/system.int32 + description: A 32-bit signed integer that is the hash code for this instance. +- api3: IsDefault() + id: PolylineAlgorithm_Coordinate_IsDefault + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Coordinate.cs#L75 + metadata: + uid: PolylineAlgorithm.Coordinate.IsDefault + commentId: M:PolylineAlgorithm.Coordinate.IsDefault +- markdown: Determines whether this coordinate is the default value (both and are 0). +- code: public bool IsDefault() +- h4: Returns +- parameters: + - type: + - text: bool + url: https://learn.microsoft.com/dotnet/api/system.boolean + description: true if both latitude and longitude are 0; otherwise, false. +- api3: ToString() + id: PolylineAlgorithm_Coordinate_ToString + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Coordinate.cs#L93 + metadata: + uid: PolylineAlgorithm.Coordinate.ToString + commentId: M:PolylineAlgorithm.Coordinate.ToString +- markdown: 'Returns a string representation of this coordinate in the format: { Latitude: [double], Longitude: [double] }.' +- code: public override string ToString() +- h4: Returns +- parameters: + - type: + - text: string + url: https://learn.microsoft.com/dotnet/api/system.string + description: A string representation of the coordinate. +- h2: Operators +- api3: operator ==(Coordinate, Coordinate) + id: PolylineAlgorithm_Coordinate_op_Equality_PolylineAlgorithm_Coordinate_PolylineAlgorithm_Coordinate_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Coordinate.cs#L119 + metadata: + uid: PolylineAlgorithm.Coordinate.op_Equality(PolylineAlgorithm.Coordinate,PolylineAlgorithm.Coordinate) + commentId: M:PolylineAlgorithm.Coordinate.op_Equality(PolylineAlgorithm.Coordinate,PolylineAlgorithm.Coordinate) +- markdown: Determines whether two instances are equal. +- code: public static bool operator ==(Coordinate left, Coordinate right) +- h4: Parameters +- parameters: + - name: left + type: + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + description: The first coordinate to compare. + - name: right + type: + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + description: The second coordinate to compare. +- h4: Returns +- parameters: + - type: + - text: bool + url: https://learn.microsoft.com/dotnet/api/system.boolean + description: true if both coordinates are equal; otherwise, false. +- api3: operator !=(Coordinate, Coordinate) + id: PolylineAlgorithm_Coordinate_op_Inequality_PolylineAlgorithm_Coordinate_PolylineAlgorithm_Coordinate_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Coordinate.cs#L129 + metadata: + uid: PolylineAlgorithm.Coordinate.op_Inequality(PolylineAlgorithm.Coordinate,PolylineAlgorithm.Coordinate) + commentId: M:PolylineAlgorithm.Coordinate.op_Inequality(PolylineAlgorithm.Coordinate,PolylineAlgorithm.Coordinate) +- markdown: Determines whether two instances are not equal. +- code: public static bool operator !=(Coordinate left, Coordinate right) +- h4: Parameters +- parameters: + - name: left + type: + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + description: The first coordinate to compare. + - name: right + type: + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + description: The second coordinate to compare. +- h4: Returns +- parameters: + - type: + - text: bool + url: https://learn.microsoft.com/dotnet/api/system.boolean + description: true if the coordinates are not equal; otherwise, false. +languageId: csharp +metadata: + description: Represents a geographic coordinate as a pair of latitude and longitude values. diff --git a/api-reference/9.0/PolylineAlgorithm.CoordinateValueType.yml b/api-reference/9.0/PolylineAlgorithm.CoordinateValueType.yml new file mode 100644 index 00000000..c39f78d6 --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.CoordinateValueType.yml @@ -0,0 +1,45 @@ +### YamlMime:ApiPage +title: Enum CoordinateValueType +body: +- api1: Enum CoordinateValueType + id: PolylineAlgorithm_CoordinateValueType + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/CoordinateValueType.cs#L11 + metadata: + uid: PolylineAlgorithm.CoordinateValueType + commentId: T:PolylineAlgorithm.CoordinateValueType +- facts: + - name: Namespace + value: + text: PolylineAlgorithm + url: PolylineAlgorithm.html + - name: Assembly + value: PolylineAlgorithm.dll +- markdown: Represents the type of a geographic coordinate value. +- code: public enum CoordinateValueType +- h2: Fields +- parameters: + - name: Latitude + default: "1" + description: >+ + Represents a latitude value. + + - name: Longitude + default: "2" + description: >+ + Represents a longitude value. + + - name: None + default: "0" + description: >+ + Represents no specific type. This value is used when the type is not applicable or not specified. + +- h2: Remarks +- markdown: >- + This enumeration is used to specify whether a coordinate value represents latitude or + + longitude. Latitude values indicate the north-south position, while longitude values indicate the east-west + + position. +languageId: csharp +metadata: + description: Represents the type of a geographic coordinate value. diff --git a/api-reference/9.0/PolylineAlgorithm.Extensions.PolylineDecoderExtensions.yml b/api-reference/9.0/PolylineAlgorithm.Extensions.PolylineDecoderExtensions.yml new file mode 100644 index 00000000..7b032c6f --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.Extensions.PolylineDecoderExtensions.yml @@ -0,0 +1,182 @@ +### YamlMime:ApiPage +title: Class PolylineDecoderExtensions +body: +- api1: Class PolylineDecoderExtensions + id: PolylineAlgorithm_Extensions_PolylineDecoderExtensions + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Extensions/PolylineDecoderExtensions.cs#L16 + metadata: + uid: PolylineAlgorithm.Extensions.PolylineDecoderExtensions + commentId: T:PolylineAlgorithm.Extensions.PolylineDecoderExtensions +- facts: + - name: Namespace + value: + text: PolylineAlgorithm.Extensions + url: PolylineAlgorithm.Extensions.html + - name: Assembly + value: PolylineAlgorithm.dll +- markdown: Provides extension methods for the interface to facilitate decoding encoded polylines. +- code: public static class PolylineDecoderExtensions +- h4: Inheritance +- inheritance: + - text: object + url: https://learn.microsoft.com/dotnet/api/system.object + - text: PolylineDecoderExtensions + url: PolylineAlgorithm.Extensions.PolylineDecoderExtensions.html +- h4: Inherited Members +- list: + - text: object.Equals(object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object) + - text: object.Equals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object) + - text: object.GetHashCode() + url: https://learn.microsoft.com/dotnet/api/system.object.gethashcode + - text: object.GetType() + url: https://learn.microsoft.com/dotnet/api/system.object.gettype + - text: object.MemberwiseClone() + url: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone + - text: object.ReferenceEquals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.referenceequals + - text: object.ToString() + url: https://learn.microsoft.com/dotnet/api/system.object.tostring +- h2: Methods +- api3: Decode(IPolylineDecoder, string) + id: PolylineAlgorithm_Extensions_PolylineDecoderExtensions_Decode_PolylineAlgorithm_Abstraction_IPolylineDecoder_PolylineAlgorithm_Polyline_PolylineAlgorithm_Coordinate__System_String_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Extensions/PolylineDecoderExtensions.cs#L32 + metadata: + uid: PolylineAlgorithm.Extensions.PolylineDecoderExtensions.Decode(PolylineAlgorithm.Abstraction.IPolylineDecoder{PolylineAlgorithm.Polyline,PolylineAlgorithm.Coordinate},System.String) + commentId: M:PolylineAlgorithm.Extensions.PolylineDecoderExtensions.Decode(PolylineAlgorithm.Abstraction.IPolylineDecoder{PolylineAlgorithm.Polyline,PolylineAlgorithm.Coordinate},System.String) +- markdown: Decodes an encoded polyline string into a sequence of geographic coordinates. +- code: public static IEnumerable Decode(this IPolylineDecoder decoder, string polyline) +- h4: Parameters +- parameters: + - name: decoder + type: + - text: IPolylineDecoder + url: PolylineAlgorithm.Abstraction.IPolylineDecoder-2.html + - < + - text: Polyline + url: PolylineAlgorithm.Polyline.html + - ',' + - " " + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + - '>' + description: The instance used to perform the decoding operation. + - name: polyline + type: + - text: string + url: https://learn.microsoft.com/dotnet/api/system.string + description: The encoded polyline string to decode. +- h4: Returns +- parameters: + - type: + - text: IEnumerable + url: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1 + - < + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + - '>' + description: An containing the decoded latitude and longitude pairs. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentNullException + url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception + description: Thrown when decoder is null. +- api3: Decode(IPolylineDecoder, char[]) + id: PolylineAlgorithm_Extensions_PolylineDecoderExtensions_Decode_PolylineAlgorithm_Abstraction_IPolylineDecoder_PolylineAlgorithm_Polyline_PolylineAlgorithm_Coordinate__System_Char___ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Extensions/PolylineDecoderExtensions.cs#L55 + metadata: + uid: PolylineAlgorithm.Extensions.PolylineDecoderExtensions.Decode(PolylineAlgorithm.Abstraction.IPolylineDecoder{PolylineAlgorithm.Polyline,PolylineAlgorithm.Coordinate},System.Char[]) + commentId: M:PolylineAlgorithm.Extensions.PolylineDecoderExtensions.Decode(PolylineAlgorithm.Abstraction.IPolylineDecoder{PolylineAlgorithm.Polyline,PolylineAlgorithm.Coordinate},System.Char[]) +- markdown: Decodes an encoded polyline represented as a character array into a sequence of geographic coordinates. +- code: public static IEnumerable Decode(this IPolylineDecoder decoder, char[] polyline) +- h4: Parameters +- parameters: + - name: decoder + type: + - text: IPolylineDecoder + url: PolylineAlgorithm.Abstraction.IPolylineDecoder-2.html + - < + - text: Polyline + url: PolylineAlgorithm.Polyline.html + - ',' + - " " + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + - '>' + description: The instance used to perform the decoding operation. + - name: polyline + type: + - text: char + url: https://learn.microsoft.com/dotnet/api/system.char + - '[' + - ']' + description: The encoded polyline as a character array to decode. +- h4: Returns +- parameters: + - type: + - text: IEnumerable + url: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1 + - < + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + - '>' + description: An containing the decoded latitude and longitude pairs. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentNullException + url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception + description: Thrown when decoder is null. +- api3: Decode(IPolylineDecoder, ReadOnlyMemory) + id: PolylineAlgorithm_Extensions_PolylineDecoderExtensions_Decode_PolylineAlgorithm_Abstraction_IPolylineDecoder_PolylineAlgorithm_Polyline_PolylineAlgorithm_Coordinate__System_ReadOnlyMemory_System_Char__ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Extensions/PolylineDecoderExtensions.cs#L78 + metadata: + uid: PolylineAlgorithm.Extensions.PolylineDecoderExtensions.Decode(PolylineAlgorithm.Abstraction.IPolylineDecoder{PolylineAlgorithm.Polyline,PolylineAlgorithm.Coordinate},System.ReadOnlyMemory{System.Char}) + commentId: M:PolylineAlgorithm.Extensions.PolylineDecoderExtensions.Decode(PolylineAlgorithm.Abstraction.IPolylineDecoder{PolylineAlgorithm.Polyline,PolylineAlgorithm.Coordinate},System.ReadOnlyMemory{System.Char}) +- markdown: Decodes an encoded polyline represented as a read-only memory of characters into a sequence of geographic coordinates. +- code: public static IEnumerable Decode(this IPolylineDecoder decoder, ReadOnlyMemory polyline) +- h4: Parameters +- parameters: + - name: decoder + type: + - text: IPolylineDecoder + url: PolylineAlgorithm.Abstraction.IPolylineDecoder-2.html + - < + - text: Polyline + url: PolylineAlgorithm.Polyline.html + - ',' + - " " + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + - '>' + description: The instance used to perform the decoding operation. + - name: polyline + type: + - text: ReadOnlyMemory + url: https://learn.microsoft.com/dotnet/api/system.readonlymemory-1 + - < + - text: char + url: https://learn.microsoft.com/dotnet/api/system.char + - '>' + description: The encoded polyline as a read-only memory of characters to decode. +- h4: Returns +- parameters: + - type: + - text: IEnumerable + url: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1 + - < + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + - '>' + description: An containing the decoded latitude and longitude pairs. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentNullException + url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception + description: Thrown when decoder is null. +languageId: csharp +metadata: + description: Provides extension methods for the interface to facilitate decoding encoded polylines. diff --git a/api-reference/9.0/PolylineAlgorithm.Extensions.PolylineEncoderExtensions.yml b/api-reference/9.0/PolylineAlgorithm.Extensions.PolylineEncoderExtensions.yml new file mode 100644 index 00000000..5958c48b --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.Extensions.PolylineEncoderExtensions.yml @@ -0,0 +1,130 @@ +### YamlMime:ApiPage +title: Class PolylineEncoderExtensions +body: +- api1: Class PolylineEncoderExtensions + id: PolylineAlgorithm_Extensions_PolylineEncoderExtensions + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Extensions/PolylineEncoderExtensions.cs#L16 + metadata: + uid: PolylineAlgorithm.Extensions.PolylineEncoderExtensions + commentId: T:PolylineAlgorithm.Extensions.PolylineEncoderExtensions +- facts: + - name: Namespace + value: + text: PolylineAlgorithm.Extensions + url: PolylineAlgorithm.Extensions.html + - name: Assembly + value: PolylineAlgorithm.dll +- markdown: Provides extension methods for the interface to facilitate encoding geographic coordinates into polylines. +- code: public static class PolylineEncoderExtensions +- h4: Inheritance +- inheritance: + - text: object + url: https://learn.microsoft.com/dotnet/api/system.object + - text: PolylineEncoderExtensions + url: PolylineAlgorithm.Extensions.PolylineEncoderExtensions.html +- h4: Inherited Members +- list: + - text: object.Equals(object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object) + - text: object.Equals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object) + - text: object.GetHashCode() + url: https://learn.microsoft.com/dotnet/api/system.object.gethashcode + - text: object.GetType() + url: https://learn.microsoft.com/dotnet/api/system.object.gettype + - text: object.MemberwiseClone() + url: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone + - text: object.ReferenceEquals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.referenceequals + - text: object.ToString() + url: https://learn.microsoft.com/dotnet/api/system.object.tostring +- h2: Methods +- api3: Encode(IPolylineEncoder, ICollection) + id: PolylineAlgorithm_Extensions_PolylineEncoderExtensions_Encode_PolylineAlgorithm_Abstraction_IPolylineEncoder_PolylineAlgorithm_Coordinate_PolylineAlgorithm_Polyline__System_Collections_Generic_ICollection_PolylineAlgorithm_Coordinate__ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Extensions/PolylineEncoderExtensions.cs#L32 + metadata: + uid: PolylineAlgorithm.Extensions.PolylineEncoderExtensions.Encode(PolylineAlgorithm.Abstraction.IPolylineEncoder{PolylineAlgorithm.Coordinate,PolylineAlgorithm.Polyline},System.Collections.Generic.ICollection{PolylineAlgorithm.Coordinate}) + commentId: M:PolylineAlgorithm.Extensions.PolylineEncoderExtensions.Encode(PolylineAlgorithm.Abstraction.IPolylineEncoder{PolylineAlgorithm.Coordinate,PolylineAlgorithm.Polyline},System.Collections.Generic.ICollection{PolylineAlgorithm.Coordinate}) +- markdown: Encodes a collection of instances into an encoded polyline. +- code: public static Polyline Encode(this IPolylineEncoder encoder, ICollection coordinates) +- h4: Parameters +- parameters: + - name: encoder + type: + - text: IPolylineEncoder + url: PolylineAlgorithm.Abstraction.IPolylineEncoder-2.html + - < + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + - ',' + - " " + - text: Polyline + url: PolylineAlgorithm.Polyline.html + - '>' + description: The instance used to perform the encoding operation. + - name: coordinates + type: + - text: ICollection + url: https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1 + - < + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + - '>' + description: The sequence of objects to encode. +- h4: Returns +- parameters: + - type: + - text: Polyline + url: PolylineAlgorithm.Polyline.html + description: A representing the encoded polyline string for the provided coordinates. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentNullException + url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception + description: Thrown when encoder is null. +- api3: Encode(IPolylineEncoder, Coordinate[]) + id: PolylineAlgorithm_Extensions_PolylineEncoderExtensions_Encode_PolylineAlgorithm_Abstraction_IPolylineEncoder_PolylineAlgorithm_Coordinate_PolylineAlgorithm_Polyline__PolylineAlgorithm_Coordinate___ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Extensions/PolylineEncoderExtensions.cs#L55 + metadata: + uid: PolylineAlgorithm.Extensions.PolylineEncoderExtensions.Encode(PolylineAlgorithm.Abstraction.IPolylineEncoder{PolylineAlgorithm.Coordinate,PolylineAlgorithm.Polyline},PolylineAlgorithm.Coordinate[]) + commentId: M:PolylineAlgorithm.Extensions.PolylineEncoderExtensions.Encode(PolylineAlgorithm.Abstraction.IPolylineEncoder{PolylineAlgorithm.Coordinate,PolylineAlgorithm.Polyline},PolylineAlgorithm.Coordinate[]) +- markdown: Encodes an array of instances into an encoded polyline. +- code: public static Polyline Encode(this IPolylineEncoder encoder, Coordinate[] coordinates) +- h4: Parameters +- parameters: + - name: encoder + type: + - text: IPolylineEncoder + url: PolylineAlgorithm.Abstraction.IPolylineEncoder-2.html + - < + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + - ',' + - " " + - text: Polyline + url: PolylineAlgorithm.Polyline.html + - '>' + description: The instance used to perform the encoding operation. + - name: coordinates + type: + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + - '[' + - ']' + description: The array of objects to encode. +- h4: Returns +- parameters: + - type: + - text: Polyline + url: PolylineAlgorithm.Polyline.html + description: A representing the encoded polyline string for the provided coordinates. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentNullException + url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception + description: Thrown when encoder is null. +languageId: csharp +metadata: + description: Provides extension methods for the interface to facilitate encoding geographic coordinates into polylines. diff --git a/api-reference/9.0/PolylineAlgorithm.Extensions.yml b/api-reference/9.0/PolylineAlgorithm.Extensions.yml new file mode 100644 index 00000000..c39da0ca --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.Extensions.yml @@ -0,0 +1,19 @@ +### YamlMime:ApiPage +title: Namespace PolylineAlgorithm.Extensions +body: +- api1: Namespace PolylineAlgorithm.Extensions + id: PolylineAlgorithm_Extensions + metadata: + uid: PolylineAlgorithm.Extensions + commentId: N:PolylineAlgorithm.Extensions +- h3: Classes +- parameters: + - type: + text: PolylineDecoderExtensions + url: PolylineAlgorithm.Extensions.PolylineDecoderExtensions.html + description: Provides extension methods for the interface to facilitate decoding encoded polylines. + - type: + text: PolylineEncoderExtensions + url: PolylineAlgorithm.Extensions.PolylineEncoderExtensions.html + description: Provides extension methods for the interface to facilitate encoding geographic coordinates into polylines. +languageId: csharp diff --git a/api-reference/9.0/PolylineAlgorithm.InvalidPolylineException.yml b/api-reference/9.0/PolylineAlgorithm.InvalidPolylineException.yml new file mode 100644 index 00000000..8193591c --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.InvalidPolylineException.yml @@ -0,0 +1,73 @@ +### YamlMime:ApiPage +title: Class InvalidPolylineException +body: +- api1: Class InvalidPolylineException + id: PolylineAlgorithm_InvalidPolylineException + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/InvalidPolylineException.cs#L19 + metadata: + uid: PolylineAlgorithm.InvalidPolylineException + commentId: T:PolylineAlgorithm.InvalidPolylineException +- facts: + - name: Namespace + value: + text: PolylineAlgorithm + url: PolylineAlgorithm.html + - name: Assembly + value: PolylineAlgorithm.dll +- markdown: Exception thrown when a polyline is determined to be malformed or invalid during processing. +- code: 'public sealed class InvalidPolylineException : Exception, ISerializable' +- h4: Inheritance +- inheritance: + - text: object + url: https://learn.microsoft.com/dotnet/api/system.object + - text: Exception + url: https://learn.microsoft.com/dotnet/api/system.exception + - text: InvalidPolylineException + url: PolylineAlgorithm.InvalidPolylineException.html +- h4: Implements +- list: + - text: ISerializable + url: https://learn.microsoft.com/dotnet/api/system.runtime.serialization.iserializable +- h4: Inherited Members +- list: + - text: Exception.GetBaseException() + url: https://learn.microsoft.com/dotnet/api/system.exception.getbaseexception + - text: Exception.GetObjectData(SerializationInfo, StreamingContext) + url: https://learn.microsoft.com/dotnet/api/system.exception.getobjectdata + - text: Exception.GetType() + url: https://learn.microsoft.com/dotnet/api/system.exception.gettype + - text: Exception.ToString() + url: https://learn.microsoft.com/dotnet/api/system.exception.tostring + - text: Exception.Data + url: https://learn.microsoft.com/dotnet/api/system.exception.data + - text: Exception.HelpLink + url: https://learn.microsoft.com/dotnet/api/system.exception.helplink + - text: Exception.HResult + url: https://learn.microsoft.com/dotnet/api/system.exception.hresult + - text: Exception.InnerException + url: https://learn.microsoft.com/dotnet/api/system.exception.innerexception + - text: Exception.Message + url: https://learn.microsoft.com/dotnet/api/system.exception.message + - text: Exception.Source + url: https://learn.microsoft.com/dotnet/api/system.exception.source + - text: Exception.StackTrace + url: https://learn.microsoft.com/dotnet/api/system.exception.stacktrace + - text: Exception.TargetSite + url: https://learn.microsoft.com/dotnet/api/system.exception.targetsite + - text: object.Equals(object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object) + - text: object.Equals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object) + - text: object.GetHashCode() + url: https://learn.microsoft.com/dotnet/api/system.object.gethashcode + - text: object.GetType() + url: https://learn.microsoft.com/dotnet/api/system.object.gettype + - text: object.ReferenceEquals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.referenceequals + - text: object.ToString() + url: https://learn.microsoft.com/dotnet/api/system.object.tostring +- h2: Remarks +- markdown: This exception is used internally to indicate that a polyline string does not conform to the expected format or contains errors. +languageId: csharp +metadata: + description: Exception thrown when a polyline is determined to be malformed or invalid during processing. diff --git a/api-reference/9.0/PolylineAlgorithm.Polyline.yml b/api-reference/9.0/PolylineAlgorithm.Polyline.yml new file mode 100644 index 00000000..28afc5bb --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.Polyline.yml @@ -0,0 +1,315 @@ +### YamlMime:ApiPage +title: Struct Polyline +body: +- api1: Struct Polyline + id: PolylineAlgorithm_Polyline + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Polyline.cs#L20 + metadata: + uid: PolylineAlgorithm.Polyline + commentId: T:PolylineAlgorithm.Polyline +- facts: + - name: Namespace + value: + text: PolylineAlgorithm + url: PolylineAlgorithm.html + - name: Assembly + value: PolylineAlgorithm.dll +- markdown: >- + Represents an immutable, read-only encoded polyline string. + + Provides methods for creation, inspection, and conversion of polyline data from various character sources. +- code: 'public readonly struct Polyline : IEquatable' +- h4: Implements +- list: + - text: IEquatable + url: https://learn.microsoft.com/dotnet/api/system.iequatable-1 +- h4: Inherited Members +- list: + - text: object.Equals(object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object) + - text: object.Equals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object) + - text: object.GetHashCode() + url: https://learn.microsoft.com/dotnet/api/system.object.gethashcode + - text: object.GetType() + url: https://learn.microsoft.com/dotnet/api/system.object.gettype + - text: object.ReferenceEquals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.referenceequals + - text: object.ToString() + url: https://learn.microsoft.com/dotnet/api/system.object.tostring +- h2: Remarks +- markdown: This struct is designed to be lightweight and efficient, allowing for quick comparisons and memory-safe operations. +- h2: Constructors +- api3: Polyline() + id: PolylineAlgorithm_Polyline__ctor + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Polyline.cs#L28 + metadata: + uid: PolylineAlgorithm.Polyline.#ctor + commentId: M:PolylineAlgorithm.Polyline.#ctor +- markdown: Initializes a new, empty instance of the struct. +- code: public Polyline() +- h2: Properties +- api3: IsEmpty + id: PolylineAlgorithm_Polyline_IsEmpty + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Polyline.cs#L50 + metadata: + uid: PolylineAlgorithm.Polyline.IsEmpty + commentId: P:PolylineAlgorithm.Polyline.IsEmpty +- markdown: Gets a value indicating whether this is empty. +- code: public bool IsEmpty { get; } +- h4: Property Value +- parameters: + - type: + - text: bool + url: https://learn.microsoft.com/dotnet/api/system.boolean +- api3: Length + id: PolylineAlgorithm_Polyline_Length + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Polyline.cs#L55 + metadata: + uid: PolylineAlgorithm.Polyline.Length + commentId: P:PolylineAlgorithm.Polyline.Length +- markdown: Gets the length of the polyline in characters. +- code: public long Length { get; } +- h4: Property Value +- parameters: + - type: + - text: long + url: https://learn.microsoft.com/dotnet/api/system.int64 +- h2: Methods +- api3: CopyTo(char[]) + id: PolylineAlgorithm_Polyline_CopyTo_System_Char___ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Polyline.cs#L69 + metadata: + uid: PolylineAlgorithm.Polyline.CopyTo(System.Char[]) + commentId: M:PolylineAlgorithm.Polyline.CopyTo(System.Char[]) +- markdown: Copies the characters of this polyline to the specified destination array. +- code: public void CopyTo(char[] destination) +- h4: Parameters +- parameters: + - name: destination + type: + - text: char + url: https://learn.microsoft.com/dotnet/api/system.char + - '[' + - ']' + description: The destination array to copy the characters to. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentNullException + url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception + description: Thrown when destination is null. + - type: + - text: ArgumentException + url: https://learn.microsoft.com/dotnet/api/system.argumentexception + description: Thrown when the length of destination does not match the polyline's length. +- api3: Equals(Polyline) + id: PolylineAlgorithm_Polyline_Equals_PolylineAlgorithm_Polyline_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Polyline.cs#L110 + metadata: + uid: PolylineAlgorithm.Polyline.Equals(PolylineAlgorithm.Polyline) + commentId: M:PolylineAlgorithm.Polyline.Equals(PolylineAlgorithm.Polyline) +- markdown: Indicates whether the current object is equal to another object of the same type. +- code: public bool Equals(Polyline other) +- h4: Parameters +- parameters: + - name: other + type: + - text: Polyline + url: PolylineAlgorithm.Polyline.html + description: An object to compare with this object. +- h4: Returns +- parameters: + - type: + - text: bool + url: https://learn.microsoft.com/dotnet/api/system.boolean + description: true if the current object is equal to the other parameter; otherwise, false. +- api3: Equals(object) + id: PolylineAlgorithm_Polyline_Equals_System_Object_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Polyline.cs#L119 + metadata: + uid: PolylineAlgorithm.Polyline.Equals(System.Object) + commentId: M:PolylineAlgorithm.Polyline.Equals(System.Object) +- markdown: Indicates whether this instance and a specified object are equal. +- code: public override bool Equals(object obj) +- h4: Parameters +- parameters: + - name: obj + type: + - text: object + url: https://learn.microsoft.com/dotnet/api/system.object + description: The object to compare with the current instance. +- h4: Returns +- parameters: + - type: + - text: bool + url: https://learn.microsoft.com/dotnet/api/system.boolean + description: true if obj and this instance are the same type and represent the same value; otherwise, false. +- api3: FromCharArray(char[]) + id: PolylineAlgorithm_Polyline_FromCharArray_System_Char___ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Polyline.cs#L168 + metadata: + uid: PolylineAlgorithm.Polyline.FromCharArray(System.Char[]) + commentId: M:PolylineAlgorithm.Polyline.FromCharArray(System.Char[]) +- markdown: Creates a from a Unicode character array. +- code: public static Polyline FromCharArray(char[] polyline) +- h4: Parameters +- parameters: + - name: polyline + type: + - text: char + url: https://learn.microsoft.com/dotnet/api/system.char + - '[' + - ']' + description: A character array representing an encoded polyline. +- h4: Returns +- parameters: + - type: + - text: Polyline + url: PolylineAlgorithm.Polyline.html + description: The instance corresponding to the specified character array. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentNullException + url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception + description: Thrown when polyline is null. +- api3: FromMemory(ReadOnlyMemory) + id: PolylineAlgorithm_Polyline_FromMemory_System_ReadOnlyMemory_System_Char__ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Polyline.cs#L205 + metadata: + uid: PolylineAlgorithm.Polyline.FromMemory(System.ReadOnlyMemory{System.Char}) + commentId: M:PolylineAlgorithm.Polyline.FromMemory(System.ReadOnlyMemory{System.Char}) +- markdown: Creates a from a read-only memory region of characters. +- code: public static Polyline FromMemory(ReadOnlyMemory polyline) +- h4: Parameters +- parameters: + - name: polyline + type: + - text: ReadOnlyMemory + url: https://learn.microsoft.com/dotnet/api/system.readonlymemory-1 + - < + - text: char + url: https://learn.microsoft.com/dotnet/api/system.char + - '>' + description: A read-only memory region representing an encoded polyline. +- h4: Returns +- parameters: + - type: + - text: Polyline + url: PolylineAlgorithm.Polyline.html + description: The instance corresponding to the specified memory region. +- api3: FromString(string) + id: PolylineAlgorithm_Polyline_FromString_System_String_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Polyline.cs#L188 + metadata: + uid: PolylineAlgorithm.Polyline.FromString(System.String) + commentId: M:PolylineAlgorithm.Polyline.FromString(System.String) +- markdown: Creates a from a string. +- code: public static Polyline FromString(string polyline) +- h4: Parameters +- parameters: + - name: polyline + type: + - text: string + url: https://learn.microsoft.com/dotnet/api/system.string + description: A string representing an encoded polyline. +- h4: Returns +- parameters: + - type: + - text: Polyline + url: PolylineAlgorithm.Polyline.html + description: The instance corresponding to the specified string. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentNullException + url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception + description: Thrown when polyline is null. +- api3: GetHashCode() + id: PolylineAlgorithm_Polyline_GetHashCode + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Polyline.cs#L124 + metadata: + uid: PolylineAlgorithm.Polyline.GetHashCode + commentId: M:PolylineAlgorithm.Polyline.GetHashCode +- markdown: Returns the hash code for this instance. +- code: public override int GetHashCode() +- h4: Returns +- parameters: + - type: + - text: int + url: https://learn.microsoft.com/dotnet/api/system.int32 + description: A 32-bit signed integer that is the hash code for this instance. +- api3: ToString() + id: PolylineAlgorithm_Polyline_ToString + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Polyline.cs#L87 + metadata: + uid: PolylineAlgorithm.Polyline.ToString + commentId: M:PolylineAlgorithm.Polyline.ToString +- markdown: Returns a string representation of the polyline. +- code: public override string ToString() +- h4: Returns +- parameters: + - type: + - text: string + url: https://learn.microsoft.com/dotnet/api/system.string + description: A string containing the characters of the polyline, or an empty string if the polyline is empty. +- h2: Operators +- api3: operator ==(Polyline, Polyline) + id: PolylineAlgorithm_Polyline_op_Equality_PolylineAlgorithm_Polyline_PolylineAlgorithm_Polyline_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Polyline.cs#L140 + metadata: + uid: PolylineAlgorithm.Polyline.op_Equality(PolylineAlgorithm.Polyline,PolylineAlgorithm.Polyline) + commentId: M:PolylineAlgorithm.Polyline.op_Equality(PolylineAlgorithm.Polyline,PolylineAlgorithm.Polyline) +- markdown: Determines whether two instances are equal. +- code: public static bool operator ==(Polyline left, Polyline right) +- h4: Parameters +- parameters: + - name: left + type: + - text: Polyline + url: PolylineAlgorithm.Polyline.html + description: The first polyline to compare. + - name: right + type: + - text: Polyline + url: PolylineAlgorithm.Polyline.html + description: The second polyline to compare. +- h4: Returns +- parameters: + - type: + - text: bool + url: https://learn.microsoft.com/dotnet/api/system.boolean + description: true if the polylines are equal; otherwise, false. +- api3: operator !=(Polyline, Polyline) + id: PolylineAlgorithm_Polyline_op_Inequality_PolylineAlgorithm_Polyline_PolylineAlgorithm_Polyline_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/Polyline.cs#L150 + metadata: + uid: PolylineAlgorithm.Polyline.op_Inequality(PolylineAlgorithm.Polyline,PolylineAlgorithm.Polyline) + commentId: M:PolylineAlgorithm.Polyline.op_Inequality(PolylineAlgorithm.Polyline,PolylineAlgorithm.Polyline) +- markdown: Determines whether two instances are not equal. +- code: public static bool operator !=(Polyline left, Polyline right) +- h4: Parameters +- parameters: + - name: left + type: + - text: Polyline + url: PolylineAlgorithm.Polyline.html + description: The first polyline to compare. + - name: right + type: + - text: Polyline + url: PolylineAlgorithm.Polyline.html + description: The second polyline to compare. +- h4: Returns +- parameters: + - type: + - text: bool + url: https://learn.microsoft.com/dotnet/api/system.boolean + description: true if the polylines are not equal; otherwise, false. +languageId: csharp +metadata: + description: >- + Represents an immutable, read-only encoded polyline string. + + Provides methods for creation, inspection, and conversion of polyline data from various character sources. diff --git a/api-reference/9.0/PolylineAlgorithm.PolylineDecoder.yml b/api-reference/9.0/PolylineAlgorithm.PolylineDecoder.yml new file mode 100644 index 00000000..831fd53f --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.PolylineDecoder.yml @@ -0,0 +1,149 @@ +### YamlMime:ApiPage +title: Class PolylineDecoder +body: +- api1: Class PolylineDecoder + id: PolylineAlgorithm_PolylineDecoder + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineDecoder.cs#L11 + metadata: + uid: PolylineAlgorithm.PolylineDecoder + commentId: T:PolylineAlgorithm.PolylineDecoder +- facts: + - name: Namespace + value: + text: PolylineAlgorithm + url: PolylineAlgorithm.html + - name: Assembly + value: PolylineAlgorithm.dll +- markdown: >- + Decodes encoded polyline strings into sequences of geographic coordinates. + + Implements the interface. +- code: 'public sealed class PolylineDecoder : AbstractPolylineDecoder, IPolylineDecoder' +- h4: Inheritance +- inheritance: + - text: object + url: https://learn.microsoft.com/dotnet/api/system.object + - text: AbstractPolylineDecoder + url: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder-2.html + - text: PolylineDecoder + url: PolylineAlgorithm.PolylineDecoder.html +- h4: Implements +- list: + - text: IPolylineDecoder + url: PolylineAlgorithm.Abstraction.IPolylineDecoder-2.html +- h4: Inherited Members +- list: + - text: AbstractPolylineDecoder.Options + url: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder-2.html#PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2_Options + - text: AbstractPolylineDecoder.Decode(Polyline) + url: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder-2.html#PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2_Decode__0_ + - text: object.Equals(object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object) + - text: object.Equals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object) + - text: object.GetHashCode() + url: https://learn.microsoft.com/dotnet/api/system.object.gethashcode + - text: object.GetType() + url: https://learn.microsoft.com/dotnet/api/system.object.gettype + - text: object.ReferenceEquals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.referenceequals + - text: object.ToString() + url: https://learn.microsoft.com/dotnet/api/system.object.tostring +- h4: Extension Methods +- list: + - text: PolylineDecoderExtensions.Decode(IPolylineDecoder, string) + url: PolylineAlgorithm.Extensions.PolylineDecoderExtensions.html#PolylineAlgorithm_Extensions_PolylineDecoderExtensions_Decode_PolylineAlgorithm_Abstraction_IPolylineDecoder_PolylineAlgorithm_Polyline_PolylineAlgorithm_Coordinate__System_String_ + - text: PolylineDecoderExtensions.Decode(IPolylineDecoder, char[]) + url: PolylineAlgorithm.Extensions.PolylineDecoderExtensions.html#PolylineAlgorithm_Extensions_PolylineDecoderExtensions_Decode_PolylineAlgorithm_Abstraction_IPolylineDecoder_PolylineAlgorithm_Polyline_PolylineAlgorithm_Coordinate__System_Char___ + - text: PolylineDecoderExtensions.Decode(IPolylineDecoder, ReadOnlyMemory) + url: PolylineAlgorithm.Extensions.PolylineDecoderExtensions.html#PolylineAlgorithm_Extensions_PolylineDecoderExtensions_Decode_PolylineAlgorithm_Abstraction_IPolylineDecoder_PolylineAlgorithm_Polyline_PolylineAlgorithm_Coordinate__System_ReadOnlyMemory_System_Char__ +- h2: Remarks +- markdown: This abstract class provides a base implementation for decoding polylines, allowing subclasses to define how to handle specific polyline formats. +- h2: Constructors +- api3: PolylineDecoder() + id: PolylineAlgorithm_PolylineDecoder__ctor + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineDecoder.cs#L13 + metadata: + uid: PolylineAlgorithm.PolylineDecoder.#ctor + commentId: M:PolylineAlgorithm.PolylineDecoder.#ctor +- markdown: Initializes a new instance of the class with default encoding options. +- code: public PolylineDecoder() +- api3: PolylineDecoder(PolylineEncodingOptions) + id: PolylineAlgorithm_PolylineDecoder__ctor_PolylineAlgorithm_PolylineEncodingOptions_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineDecoder.cs#L17 + metadata: + uid: PolylineAlgorithm.PolylineDecoder.#ctor(PolylineAlgorithm.PolylineEncodingOptions) + commentId: M:PolylineAlgorithm.PolylineDecoder.#ctor(PolylineAlgorithm.PolylineEncodingOptions) +- markdown: Initializes a new instance of the class with the specified encoding options. +- code: public PolylineDecoder(PolylineEncodingOptions options) +- h4: Parameters +- parameters: + - name: options + type: + - text: PolylineEncodingOptions + url: PolylineAlgorithm.PolylineEncodingOptions.html + description: The to use for encoding operations. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentNullException + url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception + description: Thrown when options is null +- h2: Methods +- api3: CreateCoordinate(double, double) + id: PolylineAlgorithm_PolylineDecoder_CreateCoordinate_System_Double_System_Double_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineDecoder.cs#L21 + metadata: + uid: PolylineAlgorithm.PolylineDecoder.CreateCoordinate(System.Double,System.Double) + commentId: M:PolylineAlgorithm.PolylineDecoder.CreateCoordinate(System.Double,System.Double) +- markdown: Creates a coordinate instance from the given latitude and longitude values. +- code: protected override Coordinate CreateCoordinate(double latitude, double longitude) +- h4: Parameters +- parameters: + - name: latitude + type: + - text: double + url: https://learn.microsoft.com/dotnet/api/system.double + description: The latitude value. + - name: longitude + type: + - text: double + url: https://learn.microsoft.com/dotnet/api/system.double + description: The longitude value. +- h4: Returns +- parameters: + - type: + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html + description: A coordinate instance of type . +- api3: GetReadOnlyMemory(Polyline) + id: PolylineAlgorithm_PolylineDecoder_GetReadOnlyMemory_PolylineAlgorithm_Polyline_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineDecoder.cs#L26 + metadata: + uid: PolylineAlgorithm.PolylineDecoder.GetReadOnlyMemory(PolylineAlgorithm.Polyline) + commentId: M:PolylineAlgorithm.PolylineDecoder.GetReadOnlyMemory(PolylineAlgorithm.Polyline) +- markdown: Converts the provided polyline instance into a for decoding. +- code: protected override ReadOnlyMemory GetReadOnlyMemory(Polyline polyline) +- h4: Parameters +- parameters: + - name: polyline + type: + - text: Polyline + url: PolylineAlgorithm.Polyline.html + description: The instance containing the encoded polyline data to decode. +- h4: Returns +- parameters: + - type: + - text: ReadOnlyMemory + url: https://learn.microsoft.com/dotnet/api/system.readonlymemory-1 + - < + - text: char + url: https://learn.microsoft.com/dotnet/api/system.char + - '>' + description: A representing the encoded polyline data. +languageId: csharp +metadata: + description: >- + Decodes encoded polyline strings into sequences of geographic coordinates. + + Implements the interface. diff --git a/api-reference/9.0/PolylineAlgorithm.PolylineEncoder.yml b/api-reference/9.0/PolylineAlgorithm.PolylineEncoder.yml new file mode 100644 index 00000000..aea15b12 --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.PolylineEncoder.yml @@ -0,0 +1,161 @@ +### YamlMime:ApiPage +title: Class PolylineEncoder +body: +- api1: Class PolylineEncoder + id: PolylineAlgorithm_PolylineEncoder + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncoder.cs#L11 + metadata: + uid: PolylineAlgorithm.PolylineEncoder + commentId: T:PolylineAlgorithm.PolylineEncoder +- facts: + - name: Namespace + value: + text: PolylineAlgorithm + url: PolylineAlgorithm.html + - name: Assembly + value: PolylineAlgorithm.dll +- markdown: >- + Provides functionality to encode a collection of geographic coordinates into an encoded polyline string. + + Implements the interface. +- code: 'public sealed class PolylineEncoder : AbstractPolylineEncoder, IPolylineEncoder' +- h4: Inheritance +- inheritance: + - text: object + url: https://learn.microsoft.com/dotnet/api/system.object + - text: AbstractPolylineEncoder + url: PolylineAlgorithm.Abstraction.AbstractPolylineEncoder-2.html + - text: PolylineEncoder + url: PolylineAlgorithm.PolylineEncoder.html +- h4: Implements +- list: + - text: IPolylineEncoder + url: PolylineAlgorithm.Abstraction.IPolylineEncoder-2.html +- h4: Inherited Members +- list: + - text: AbstractPolylineEncoder.Options + url: PolylineAlgorithm.Abstraction.AbstractPolylineEncoder-2.html#PolylineAlgorithm_Abstraction_AbstractPolylineEncoder_2_Options + - text: AbstractPolylineEncoder.Encode(IEnumerable) + url: PolylineAlgorithm.Abstraction.AbstractPolylineEncoder-2.html#PolylineAlgorithm_Abstraction_AbstractPolylineEncoder_2_Encode_System_Collections_Generic_IEnumerable__0__ + - text: object.Equals(object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object) + - text: object.Equals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object) + - text: object.GetHashCode() + url: https://learn.microsoft.com/dotnet/api/system.object.gethashcode + - text: object.GetType() + url: https://learn.microsoft.com/dotnet/api/system.object.gettype + - text: object.ReferenceEquals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.referenceequals + - text: object.ToString() + url: https://learn.microsoft.com/dotnet/api/system.object.tostring +- h4: Extension Methods +- list: + - text: PolylineEncoderExtensions.Encode(IPolylineEncoder, ICollection) + url: PolylineAlgorithm.Extensions.PolylineEncoderExtensions.html#PolylineAlgorithm_Extensions_PolylineEncoderExtensions_Encode_PolylineAlgorithm_Abstraction_IPolylineEncoder_PolylineAlgorithm_Coordinate_PolylineAlgorithm_Polyline__System_Collections_Generic_ICollection_PolylineAlgorithm_Coordinate__ + - text: PolylineEncoderExtensions.Encode(IPolylineEncoder, Coordinate[]) + url: PolylineAlgorithm.Extensions.PolylineEncoderExtensions.html#PolylineAlgorithm_Extensions_PolylineEncoderExtensions_Encode_PolylineAlgorithm_Abstraction_IPolylineEncoder_PolylineAlgorithm_Coordinate_PolylineAlgorithm_Polyline__PolylineAlgorithm_Coordinate___ +- h2: Remarks +- markdown: This abstract class serves as a base for specific polyline encoders, allowing customization of the encoding process. +- h2: Constructors +- api3: PolylineEncoder() + id: PolylineAlgorithm_PolylineEncoder__ctor + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncoder.cs#L13 + metadata: + uid: PolylineAlgorithm.PolylineEncoder.#ctor + commentId: M:PolylineAlgorithm.PolylineEncoder.#ctor +- markdown: Initializes a new instance of the class with default encoding options. +- code: public PolylineEncoder() +- api3: PolylineEncoder(PolylineEncodingOptions) + id: PolylineAlgorithm_PolylineEncoder__ctor_PolylineAlgorithm_PolylineEncodingOptions_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncoder.cs#L17 + metadata: + uid: PolylineAlgorithm.PolylineEncoder.#ctor(PolylineAlgorithm.PolylineEncodingOptions) + commentId: M:PolylineAlgorithm.PolylineEncoder.#ctor(PolylineAlgorithm.PolylineEncodingOptions) +- markdown: Initializes a new instance of the class with the specified encoding options. +- code: public PolylineEncoder(PolylineEncodingOptions options) +- h4: Parameters +- parameters: + - name: options + type: + - text: PolylineEncodingOptions + url: PolylineAlgorithm.PolylineEncodingOptions.html + description: The to use for encoding operations. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentNullException + url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception + description: Thrown when options is null +- h2: Methods +- api3: CreatePolyline(ReadOnlyMemory) + id: PolylineAlgorithm_PolylineEncoder_CreatePolyline_System_ReadOnlyMemory_System_Char__ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncoder.cs#L31 + metadata: + uid: PolylineAlgorithm.PolylineEncoder.CreatePolyline(System.ReadOnlyMemory{System.Char}) + commentId: M:PolylineAlgorithm.PolylineEncoder.CreatePolyline(System.ReadOnlyMemory{System.Char}) +- markdown: Creates a polyline instance from the provided read-only sequence of characters. +- code: protected override Polyline CreatePolyline(ReadOnlyMemory polyline) +- h4: Parameters +- parameters: + - name: polyline + type: + - text: ReadOnlyMemory + url: https://learn.microsoft.com/dotnet/api/system.readonlymemory-1 + - < + - text: char + url: https://learn.microsoft.com/dotnet/api/system.char + - '>' + description: A containing the encoded polyline characters. +- h4: Returns +- parameters: + - type: + - text: Polyline + url: PolylineAlgorithm.Polyline.html + description: An instance of representing the encoded polyline. +- api3: GetLatitude(Coordinate) + id: PolylineAlgorithm_PolylineEncoder_GetLatitude_PolylineAlgorithm_Coordinate_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncoder.cs#L21 + metadata: + uid: PolylineAlgorithm.PolylineEncoder.GetLatitude(PolylineAlgorithm.Coordinate) + commentId: M:PolylineAlgorithm.PolylineEncoder.GetLatitude(PolylineAlgorithm.Coordinate) +- markdown: Extracts the latitude value from the specified coordinate. +- code: protected override double GetLatitude(Coordinate coordinate) +- h4: Parameters +- parameters: + - name: coordinate + type: + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html +- h4: Returns +- parameters: + - type: + - text: double + url: https://learn.microsoft.com/dotnet/api/system.double + description: The latitude value as a . +- api3: GetLongitude(Coordinate) + id: PolylineAlgorithm_PolylineEncoder_GetLongitude_PolylineAlgorithm_Coordinate_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncoder.cs#L26 + metadata: + uid: PolylineAlgorithm.PolylineEncoder.GetLongitude(PolylineAlgorithm.Coordinate) + commentId: M:PolylineAlgorithm.PolylineEncoder.GetLongitude(PolylineAlgorithm.Coordinate) +- markdown: Extracts the longitude value from the specified coordinate. +- code: protected override double GetLongitude(Coordinate coordinate) +- h4: Parameters +- parameters: + - name: coordinate + type: + - text: Coordinate + url: PolylineAlgorithm.Coordinate.html +- h4: Returns +- parameters: + - type: + - text: double + url: https://learn.microsoft.com/dotnet/api/system.double + description: The longitude value as a . +languageId: csharp +metadata: + description: >- + Provides functionality to encode a collection of geographic coordinates into an encoded polyline string. + + Implements the interface. diff --git a/api-reference/9.0/PolylineAlgorithm.PolylineEncoding.yml b/api-reference/9.0/PolylineAlgorithm.PolylineEncoding.yml new file mode 100644 index 00000000..83a2ad65 --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.PolylineEncoding.yml @@ -0,0 +1,254 @@ +### YamlMime:ApiPage +title: Class PolylineEncoding +body: +- api1: Class PolylineEncoding + id: PolylineAlgorithm_PolylineEncoding + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncoding.cs#L19 + metadata: + uid: PolylineAlgorithm.PolylineEncoding + commentId: T:PolylineAlgorithm.PolylineEncoding +- facts: + - name: Namespace + value: + text: PolylineAlgorithm + url: PolylineAlgorithm.html + - name: Assembly + value: PolylineAlgorithm.dll +- markdown: >- + Provides methods for encoding and decoding polyline data, as well as utilities for normalizing and de-normalizing + + geographic coordinate values. +- code: public static class PolylineEncoding +- h4: Inheritance +- inheritance: + - text: object + url: https://learn.microsoft.com/dotnet/api/system.object + - text: PolylineEncoding + url: PolylineAlgorithm.PolylineEncoding.html +- h4: Inherited Members +- list: + - text: object.Equals(object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object) + - text: object.Equals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object) + - text: object.GetHashCode() + url: https://learn.microsoft.com/dotnet/api/system.object.gethashcode + - text: object.GetType() + url: https://learn.microsoft.com/dotnet/api/system.object.gettype + - text: object.MemberwiseClone() + url: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone + - text: object.ReferenceEquals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.referenceequals + - text: object.ToString() + url: https://learn.microsoft.com/dotnet/api/system.object.tostring +- h2: Remarks +- markdown: >- + The class includes functionality for working with encoded polyline + data, such as reading and writing encoded values, as well as methods for normalizing and de-normalizing geographic + coordinates. It also provides validation utilities to ensure values conform to expected ranges for latitude and + longitude. +- h2: Methods +- api3: Denormalize(int, CoordinateValueType) + id: PolylineAlgorithm_PolylineEncoding_Denormalize_System_Int32_PolylineAlgorithm_CoordinateValueType_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncoding.cs#L91 + metadata: + uid: PolylineAlgorithm.PolylineEncoding.Denormalize(System.Int32,PolylineAlgorithm.CoordinateValueType) + commentId: M:PolylineAlgorithm.PolylineEncoding.Denormalize(System.Int32,PolylineAlgorithm.CoordinateValueType) +- markdown: Converts a normalized integer value to its denormalized double representation based on the specified type. +- code: public static double Denormalize(int value, CoordinateValueType type) +- h4: Parameters +- parameters: + - name: value + type: + - text: int + url: https://learn.microsoft.com/dotnet/api/system.int32 + description: The normalized integer value to be denormalized. Must be within the valid range for the specified type. + - name: type + type: + - text: CoordinateValueType + url: PolylineAlgorithm.CoordinateValueType.html + description: The type that defines the valid range for value. +- h4: Returns +- parameters: + - type: + - text: double + url: https://learn.microsoft.com/dotnet/api/system.double + description: The denormalized double representation of the input value. Returns 0.0 if value is 0. +- h4: Remarks +- markdown: >- + The denormalization process divides the input value by a predefined precision factor to + produce the resulting double. Ensure that value is validated against the specified type before calling this method. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentOutOfRangeException + url: https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception + description: Thrown when value is outside the valid range for the specified type. +- api3: GetCharCount(int) + id: PolylineAlgorithm_PolylineEncoding_GetCharCount_System_Int32_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncoding.cs#L222 + metadata: + uid: PolylineAlgorithm.PolylineEncoding.GetCharCount(System.Int32) + commentId: M:PolylineAlgorithm.PolylineEncoding.GetCharCount(System.Int32) +- markdown: >- + Determines the number of characters required to represent the specified integer value within predefined + + variance ranges. +- code: public static int GetCharCount(int variance) +- h4: Parameters +- parameters: + - name: variance + type: + - text: int + url: https://learn.microsoft.com/dotnet/api/system.int32 + description: >- + The integer value for which the character count is calculated. Must be within the range of a 32-bit signed + + integer. +- h4: Returns +- parameters: + - type: + - text: int + url: https://learn.microsoft.com/dotnet/api/system.int32 + description: >- + The number of characters required to represent the variance value, based on its magnitude. + + Returns a value between 1 and 6 inclusive. +- h4: Remarks +- markdown: >- + The method uses predefined ranges to efficiently determine the character count. Smaller + + values require fewer characters, while larger values require more. This method is optimized for performance + + using a switch expression. +- api3: Normalize(double, CoordinateValueType) + id: PolylineAlgorithm_PolylineEncoding_Normalize_System_Double_PolylineAlgorithm_CoordinateValueType_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncoding.cs#L180 + metadata: + uid: PolylineAlgorithm.PolylineEncoding.Normalize(System.Double,PolylineAlgorithm.CoordinateValueType) + commentId: M:PolylineAlgorithm.PolylineEncoding.Normalize(System.Double,PolylineAlgorithm.CoordinateValueType) +- markdown: Normalizes a given numeric value based on the specified type and precision settings. +- code: public static int Normalize(double value, CoordinateValueType type) +- h4: Parameters +- parameters: + - name: value + type: + - text: double + url: https://learn.microsoft.com/dotnet/api/system.double + description: The numeric value to normalize. Must be a finite number. + - name: type + type: + - text: CoordinateValueType + url: PolylineAlgorithm.CoordinateValueType.html + description: The type against which the value is validated. Determines the acceptable range for the value. +- h4: Returns +- parameters: + - type: + - text: int + url: https://learn.microsoft.com/dotnet/api/system.int32 + description: An integer representing the normalized value. Returns 0 if the input value is 0.0. +- h4: Remarks +- markdown: >- + This method validates the input value to ensure it is finite and within the acceptable range + + for the specified type. If the value is valid, it applies a normalization algorithm using a predefined precision + + factor. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentOutOfRangeException + url: https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception + description: >- + Thrown when value is not a finite number or is outside the valid range for the specified + + type. +- api3: TryReadValue(ref int, ref ReadOnlyMemory, ref int) + id: PolylineAlgorithm_PolylineEncoding_TryReadValue_System_Int32__System_ReadOnlyMemory_System_Char___System_Int32__ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncoding.cs#L40 + metadata: + uid: PolylineAlgorithm.PolylineEncoding.TryReadValue(System.Int32@,System.ReadOnlyMemory{System.Char}@,System.Int32@) + commentId: M:PolylineAlgorithm.PolylineEncoding.TryReadValue(System.Int32@,System.ReadOnlyMemory{System.Char}@,System.Int32@) +- markdown: Attempts to read a value from the specified buffer and updates the variance. +- code: public static bool TryReadValue(ref int variance, ref ReadOnlyMemory buffer, ref int position) +- h4: Parameters +- parameters: + - name: variance + type: + - text: int + url: https://learn.microsoft.com/dotnet/api/system.int32 + description: A reference to the integer that will be updated based on the value read from the buffer. + - name: buffer + type: + - text: ReadOnlyMemory + url: https://learn.microsoft.com/dotnet/api/system.readonlymemory-1 + - < + - text: char + url: https://learn.microsoft.com/dotnet/api/system.char + - '>' + description: A reference to the read-only memory buffer containing the data to be processed. + - name: position + type: + - text: int + url: https://learn.microsoft.com/dotnet/api/system.int32 + description: A reference to the current position within the buffer. The position is incremented as the method reads data. +- h4: Returns +- parameters: + - type: + - text: bool + url: https://learn.microsoft.com/dotnet/api/system.boolean + description: true if a value was successfully read and the end of the buffer was not reached; otherwise, false. +- h4: Remarks +- markdown: >- + This method processes the buffer starting at the specified position and attempts to decode a value. + The decoded value is used to update the variance parameter. The method stops reading when a + termination condition is met or the end of the buffer is reached. +- api3: TryWriteValue(int, ref Span, ref int) + id: PolylineAlgorithm_PolylineEncoding_TryWriteValue_System_Int32_System_Span_System_Char___System_Int32__ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncoding.cs#L133 + metadata: + uid: PolylineAlgorithm.PolylineEncoding.TryWriteValue(System.Int32,System.Span{System.Char}@,System.Int32@) + commentId: M:PolylineAlgorithm.PolylineEncoding.TryWriteValue(System.Int32,System.Span{System.Char}@,System.Int32@) +- markdown: Attempts to write a value derived from the specified variance into the provided buffer at the given position. +- code: public static bool TryWriteValue(int variance, ref Span buffer, ref int position) +- h4: Parameters +- parameters: + - name: variance + type: + - text: int + url: https://learn.microsoft.com/dotnet/api/system.int32 + description: The integer value used to calculate the output to be written into the buffer. + - name: buffer + type: + - text: Span + url: https://learn.microsoft.com/dotnet/api/system.span-1 + - < + - text: char + url: https://learn.microsoft.com/dotnet/api/system.char + - '>' + description: A reference to the span of characters where the value will be written. + - name: position + type: + - text: int + url: https://learn.microsoft.com/dotnet/api/system.int32 + description: >- + A reference to the current position in the buffer where writing begins. This value is updated to reflect the new + + position after writing. +- h4: Returns +- parameters: + - type: + - text: bool + url: https://learn.microsoft.com/dotnet/api/system.boolean + description: true if the value was successfully written to the buffer; otherwise, false. +- h4: Remarks +- markdown: >- + This method performs bounds checking to ensure that the buffer has sufficient space to + + accommodate the calculated value. If the buffer does not have enough space, the method returns false without modifying the buffer or position. +languageId: csharp +metadata: + description: >- + Provides methods for encoding and decoding polyline data, as well as utilities for normalizing and de-normalizing + + geographic coordinate values. diff --git a/api-reference/9.0/PolylineAlgorithm.PolylineEncodingOptions.yml b/api-reference/9.0/PolylineAlgorithm.PolylineEncodingOptions.yml new file mode 100644 index 00000000..89919e43 --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.PolylineEncodingOptions.yml @@ -0,0 +1,74 @@ +### YamlMime:ApiPage +title: Class PolylineEncodingOptions +body: +- api1: Class PolylineEncodingOptions + id: PolylineAlgorithm_PolylineEncodingOptions + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncodingOptions.cs#L18 + metadata: + uid: PolylineAlgorithm.PolylineEncodingOptions + commentId: T:PolylineAlgorithm.PolylineEncodingOptions +- facts: + - name: Namespace + value: + text: PolylineAlgorithm + url: PolylineAlgorithm.html + - name: Assembly + value: PolylineAlgorithm.dll +- markdown: Options for configuring polyline encoding. +- code: public sealed class PolylineEncodingOptions +- h4: Inheritance +- inheritance: + - text: object + url: https://learn.microsoft.com/dotnet/api/system.object + - text: PolylineEncodingOptions + url: PolylineAlgorithm.PolylineEncodingOptions.html +- h4: Inherited Members +- list: + - text: object.Equals(object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object) + - text: object.Equals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object) + - text: object.GetHashCode() + url: https://learn.microsoft.com/dotnet/api/system.object.gethashcode + - text: object.GetType() + url: https://learn.microsoft.com/dotnet/api/system.object.gettype + - text: object.ReferenceEquals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.referenceequals + - text: object.ToString() + url: https://learn.microsoft.com/dotnet/api/system.object.tostring +- h2: Remarks +- markdown: This class allows you to set options such as buffer size and logger factory for encoding operations. +- h2: Properties +- api3: LoggerFactory + id: PolylineAlgorithm_PolylineEncodingOptions_LoggerFactory + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncodingOptions.cs#L34 + metadata: + uid: PolylineAlgorithm.PolylineEncodingOptions.LoggerFactory + commentId: P:PolylineAlgorithm.PolylineEncodingOptions.LoggerFactory +- markdown: Gets or sets the precision for encoding coordinates. +- code: public ILoggerFactory LoggerFactory { get; } +- h4: Property Value +- parameters: + - type: + - text: ILoggerFactory + url: https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.iloggerfactory +- h4: Remarks +- markdown: The default logger factory is , which does not log any messages. +- api3: MaxBufferSize + id: PolylineAlgorithm_PolylineEncodingOptions_MaxBufferSize + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncodingOptions.cs#L26 + metadata: + uid: PolylineAlgorithm.PolylineEncodingOptions.MaxBufferSize + commentId: P:PolylineAlgorithm.PolylineEncodingOptions.MaxBufferSize +- markdown: Gets the maximum buffer size for encoding operations. +- code: public int MaxBufferSize { get; } +- h4: Property Value +- parameters: + - type: + - text: int + url: https://learn.microsoft.com/dotnet/api/system.int32 +- h4: Remarks +- markdown: The default maximum buffer size is 64,000 bytes (64 KB). This can be adjusted based on the expected size of the polyline data, but should be enough for common cases. +languageId: csharp +metadata: + description: Options for configuring polyline encoding. diff --git a/api-reference/9.0/PolylineAlgorithm.PolylineEncodingOptionsBuilder.yml b/api-reference/9.0/PolylineAlgorithm.PolylineEncodingOptionsBuilder.yml new file mode 100644 index 00000000..c4eebc57 --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.PolylineEncodingOptionsBuilder.yml @@ -0,0 +1,126 @@ +### YamlMime:ApiPage +title: Class PolylineEncodingOptionsBuilder +body: +- api1: Class PolylineEncodingOptionsBuilder + id: PolylineAlgorithm_PolylineEncodingOptionsBuilder + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncodingOptionsBuilder.cs#L15 + metadata: + uid: PolylineAlgorithm.PolylineEncodingOptionsBuilder + commentId: T:PolylineAlgorithm.PolylineEncodingOptionsBuilder +- facts: + - name: Namespace + value: + text: PolylineAlgorithm + url: PolylineAlgorithm.html + - name: Assembly + value: PolylineAlgorithm.dll +- markdown: Provides a builder for configuring options for polyline encoding operations. +- code: public class PolylineEncodingOptionsBuilder +- h4: Inheritance +- inheritance: + - text: object + url: https://learn.microsoft.com/dotnet/api/system.object + - text: PolylineEncodingOptionsBuilder + url: PolylineAlgorithm.PolylineEncodingOptionsBuilder.html +- h4: Inherited Members +- list: + - text: object.Equals(object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object) + - text: object.Equals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object) + - text: object.GetHashCode() + url: https://learn.microsoft.com/dotnet/api/system.object.gethashcode + - text: object.GetType() + url: https://learn.microsoft.com/dotnet/api/system.object.gettype + - text: object.MemberwiseClone() + url: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone + - text: object.ReferenceEquals(object, object) + url: https://learn.microsoft.com/dotnet/api/system.object.referenceequals + - text: object.ToString() + url: https://learn.microsoft.com/dotnet/api/system.object.tostring +- h2: Methods +- api3: Build() + id: PolylineAlgorithm_PolylineEncodingOptionsBuilder_Build + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncodingOptionsBuilder.cs#L37 + metadata: + uid: PolylineAlgorithm.PolylineEncodingOptionsBuilder.Build + commentId: M:PolylineAlgorithm.PolylineEncodingOptionsBuilder.Build +- markdown: Builds a new instance using the configured options. +- code: public PolylineEncodingOptions Build() +- h4: Returns +- parameters: + - type: + - text: PolylineEncodingOptions + url: PolylineAlgorithm.PolylineEncodingOptions.html + description: A configured instance. +- api3: Create() + id: PolylineAlgorithm_PolylineEncodingOptionsBuilder_Create + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncodingOptionsBuilder.cs#L27 + metadata: + uid: PolylineAlgorithm.PolylineEncodingOptionsBuilder.Create + commentId: M:PolylineAlgorithm.PolylineEncodingOptionsBuilder.Create +- markdown: Creates a new instance for the specified coordinate type. +- code: public static PolylineEncodingOptionsBuilder Create() +- h4: Returns +- parameters: + - type: + - text: PolylineEncodingOptionsBuilder + url: PolylineAlgorithm.PolylineEncodingOptionsBuilder.html + description: An instance for configuring polyline encoding options. +- api3: WithLoggerFactory(ILoggerFactory) + id: PolylineAlgorithm_PolylineEncodingOptionsBuilder_WithLoggerFactory_Microsoft_Extensions_Logging_ILoggerFactory_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncodingOptionsBuilder.cs#L72 + metadata: + uid: PolylineAlgorithm.PolylineEncodingOptionsBuilder.WithLoggerFactory(Microsoft.Extensions.Logging.ILoggerFactory) + commentId: M:PolylineAlgorithm.PolylineEncodingOptionsBuilder.WithLoggerFactory(Microsoft.Extensions.Logging.ILoggerFactory) +- markdown: Sets the logger factory for logging during encoding operations. +- code: public PolylineEncodingOptionsBuilder WithLoggerFactory(ILoggerFactory loggerFactory) +- h4: Parameters +- parameters: + - name: loggerFactory + type: + - text: ILoggerFactory + url: https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.iloggerfactory + description: The instance of a logger factory. +- h4: Returns +- parameters: + - type: + - text: PolylineEncodingOptionsBuilder + url: PolylineAlgorithm.PolylineEncodingOptionsBuilder.html + description: The current builder instance. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentNullException + url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception + description: Thrown when loggerFactory is null. +- api3: WithMaxBufferSize(int) + id: PolylineAlgorithm_PolylineEncodingOptionsBuilder_WithMaxBufferSize_System_Int32_ + src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/dependabot/nuget/src/PolylineAlgorithm/Microsoft.Extensions.Logging.Abstractions-9.0.8/src/PolylineAlgorithm/PolylineEncodingOptionsBuilder.cs#L54 + metadata: + uid: PolylineAlgorithm.PolylineEncodingOptionsBuilder.WithMaxBufferSize(System.Int32) + commentId: M:PolylineAlgorithm.PolylineEncodingOptionsBuilder.WithMaxBufferSize(System.Int32) +- markdown: Sets the buffer size for encoding operations. +- code: public PolylineEncodingOptionsBuilder WithMaxBufferSize(int bufferSize) +- h4: Parameters +- parameters: + - name: bufferSize + type: + - text: int + url: https://learn.microsoft.com/dotnet/api/system.int32 + description: The maximum buffer size. Must be greater than 11. +- h4: Returns +- parameters: + - type: + - text: PolylineEncodingOptionsBuilder + url: PolylineAlgorithm.PolylineEncodingOptionsBuilder.html + description: The current builder instance. +- h4: Exceptions +- parameters: + - type: + - text: ArgumentOutOfRangeException + url: https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception + description: Thrown when bufferSize is less than or equal to 11. +languageId: csharp +metadata: + description: Provides a builder for configuring options for polyline encoding operations. diff --git a/api-reference/9.0/PolylineAlgorithm.yml b/api-reference/9.0/PolylineAlgorithm.yml new file mode 100644 index 00000000..ace2f946 --- /dev/null +++ b/api-reference/9.0/PolylineAlgorithm.yml @@ -0,0 +1,71 @@ +### YamlMime:ApiPage +title: Namespace PolylineAlgorithm +body: +- api1: Namespace PolylineAlgorithm + id: PolylineAlgorithm + metadata: + uid: PolylineAlgorithm + commentId: N:PolylineAlgorithm +- h3: Namespaces +- parameters: + - type: + text: PolylineAlgorithm.Abstraction + url: PolylineAlgorithm.Abstraction.html + - type: + text: PolylineAlgorithm.Extensions + url: PolylineAlgorithm.Extensions.html +- h3: Classes +- parameters: + - type: + text: InvalidPolylineException + url: PolylineAlgorithm.InvalidPolylineException.html + description: Exception thrown when a polyline is determined to be malformed or invalid during processing. + - type: + text: PolylineDecoder + url: PolylineAlgorithm.PolylineDecoder.html + description: >- + Decodes encoded polyline strings into sequences of geographic coordinates. + + Implements the interface. + - type: + text: PolylineEncoder + url: PolylineAlgorithm.PolylineEncoder.html + description: >- + Provides functionality to encode a collection of geographic coordinates into an encoded polyline string. + + Implements the interface. + - type: + text: PolylineEncoding + url: PolylineAlgorithm.PolylineEncoding.html + description: >- + Provides methods for encoding and decoding polyline data, as well as utilities for normalizing and de-normalizing + + geographic coordinate values. + - type: + text: PolylineEncodingOptions + url: PolylineAlgorithm.PolylineEncodingOptions.html + description: Options for configuring polyline encoding. + - type: + text: PolylineEncodingOptionsBuilder + url: PolylineAlgorithm.PolylineEncodingOptionsBuilder.html + description: Provides a builder for configuring options for polyline encoding operations. +- h3: Structs +- parameters: + - type: + text: Coordinate + url: PolylineAlgorithm.Coordinate.html + description: Represents a geographic coordinate as a pair of latitude and longitude values. + - type: + text: Polyline + url: PolylineAlgorithm.Polyline.html + description: >- + Represents an immutable, read-only encoded polyline string. + + Provides methods for creation, inspection, and conversion of polyline data from various character sources. +- h3: Enums +- parameters: + - type: + text: CoordinateValueType + url: PolylineAlgorithm.CoordinateValueType.html + description: Represents the type of a geographic coordinate value. +languageId: csharp diff --git a/api-reference/9.0/toc.yml b/api-reference/9.0/toc.yml new file mode 100644 index 00000000..b69f5d3f --- /dev/null +++ b/api-reference/9.0/toc.yml @@ -0,0 +1,46 @@ +### YamlMime:TableOfContent +- name: PolylineAlgorithm + href: PolylineAlgorithm.yml + items: + - name: Classes + - name: InvalidPolylineException + href: PolylineAlgorithm.InvalidPolylineException.yml + - name: PolylineDecoder + href: PolylineAlgorithm.PolylineDecoder.yml + - name: PolylineEncoder + href: PolylineAlgorithm.PolylineEncoder.yml + - name: PolylineEncoding + href: PolylineAlgorithm.PolylineEncoding.yml + - name: PolylineEncodingOptions + href: PolylineAlgorithm.PolylineEncodingOptions.yml + - name: PolylineEncodingOptionsBuilder + href: PolylineAlgorithm.PolylineEncodingOptionsBuilder.yml + - name: Structs + - name: Coordinate + href: PolylineAlgorithm.Coordinate.yml + - name: Polyline + href: PolylineAlgorithm.Polyline.yml + - name: Enums + - name: CoordinateValueType + href: PolylineAlgorithm.CoordinateValueType.yml +- name: PolylineAlgorithm.Abstraction + href: PolylineAlgorithm.Abstraction.yml + items: + - name: Classes + - name: AbstractPolylineDecoder + href: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder-2.yml + - name: AbstractPolylineEncoder + href: PolylineAlgorithm.Abstraction.AbstractPolylineEncoder-2.yml + - name: Interfaces + - name: IPolylineDecoder + href: PolylineAlgorithm.Abstraction.IPolylineDecoder-2.yml + - name: IPolylineEncoder + href: PolylineAlgorithm.Abstraction.IPolylineEncoder-2.yml +- name: PolylineAlgorithm.Extensions + href: PolylineAlgorithm.Extensions.yml + items: + - name: Classes + - name: PolylineDecoderExtensions + href: PolylineAlgorithm.Extensions.PolylineDecoderExtensions.yml + - name: PolylineEncoderExtensions + href: PolylineAlgorithm.Extensions.PolylineEncoderExtensions.yml diff --git a/src/PolylineAlgorithm/PolylineAlgorithm.csproj b/src/PolylineAlgorithm/PolylineAlgorithm.csproj index 0c763650..0442fcdf 100644 --- a/src/PolylineAlgorithm/PolylineAlgorithm.csproj +++ b/src/PolylineAlgorithm/PolylineAlgorithm.csproj @@ -51,7 +51,7 @@ all runtime; build; native; contentfiles; analyzers - +