Merge branch 'develop/1.0' of https://github.com/dropoutcoder/polyline-algorithm-csharp into develop/1.0

Author: Petr Sramek

benchmarks/PolylineAlgorithm.Benchmarks/GlobalSuppressions.cs

@@ -1,6 +1,6 @@
-//  
-// Copyright (c) Pete Sramek. All rights reserved.  
-// Licensed under the MIT License. See LICENSE file in the project root for full license information.  
+//
+// Copyright © Pete Sramek. All rights reserved.
+// Licensed under the MIT License. See LICENSE file in the project root for full license information.
 //
 
 using System.Diagnostics.CodeAnalysis;

benchmarks/PolylineAlgorithm.Benchmarks/PolylineDecoderBenchmark.cs

@@ -1,6 +1,6 @@
-//  
-// Copyright (c) Pete Sramek. All rights reserved.  
-// Licensed under the MIT License. See LICENSE file in the project root for full license information.  
+//
+// Copyright © Pete Sramek. All rights reserved.
+// Licensed under the MIT License. See LICENSE file in the project root for full license information.
 //
 
 namespace PolylineAlgorithm.Benchmarks;
@@ -10,7 +10,8 @@ namespace PolylineAlgorithm.Benchmarks;
 using PolylineAlgorithm;
 
 [RankColumn]
-public class PolylineDecoderBenchmark {
+public class PolylineDecoderBenchmark
+{
     private readonly Consumer _consumer = new();
 
 #pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
@@ -24,14 +25,16 @@ public class PolylineDecoderBenchmark {
     public PolylineDecoder Decoder = new();
 
     [GlobalSetup]
-    public void SetupData() {
+    public void SetupData()
+    {
         StringValue = @"sq_|Fptm{UrbxoHinoiEuhmbHctjfc@`rocCt|nfJgiauLvc_uIh`pg_@h_fkVgctZoyqfW{rxgQhhymFpuvvDwqcfTlqbcBiegdTwf{uNngc|z@{vhlDnsi_B~nz`O}d_hNp{n`E}kcoKm`bCiul~\jhg|Hv{qoWshzh\{lf_G`pzMqm|bLzswoQbhcm`@b`}cIgignPgxntR|}vo^f~|}L}|_jBa|ujWuxkjQfj|w[wsz`Pmdb{XohnwA`srxWjitms@c_~`Tava_l@jxxcF`d|zHcpnaMnd{kYzccwPxzpiHfsxlL}jjjQqvdbIikyvj@cjdqTh`zoDzqleHnfmik@tbnoB_t}gFkzx_Ct_eiP`wxrBcd_|w@zlhfPtlxgBkwyyZn|~tFlpj|HxqiwUnddkFoo|nTee}dSfkcg`@py`uQiguom@zkkpEfcgkAntuuDzl~il@ir_gCrd~nI_ryeC_qmmMl_kgCz`qgFzkejBmlchYyp`hZ`_cuYzuc}Onqz}Ew~Gcsmj@lp{Hqj_gz@ne{pJnny~]g{tuNxbno[lfq_Lqhwjt@qn|cCuxnMyivuIh{|tR`ylsQlqbfO}rf`LxghfBg~{nAv`gdNbjh_Fglt|NfxwyBowwhW{bdtNdbkqe@rxtwSy{_fX{btm@va`_LkhwuUyqgzK`xdnKgbwsFigt_Mofdn\h|x[ccoPtbpvNz}skb@pl~xEqascV_wsx[`f_z]zewFs`zjAhturWxayhJqmfaAjmhhHxwuwF_aru@ojemVq|beu@kkucBdmryTevflDcbmdAnp|dHfpbd^io}z@e~}dFzcybQ}`hxOyt|bNl}blLnuspKk|t|k@itjfHt}}aVyzmcF_rgmLct}x@bazdq@loajBxygb@f}krVgnuqOcrx_Daqvp_@ew}yUn}kpU|uwnItashEpe_aHusi{Fsu}_Ewfhv[dzhzKxh_qXucxfXmynkGxuqbW|ppgi@vrsq@clryZk`bt^spkyP";
         CharArray = StringValue.ToCharArray();
         Memory = StringValue.AsMemory();
     }
 
     [Benchmark]
-    public void PolylineDecoder_Decode_FromString() {
+    public void PolylineDecoder_Decode_FromString()
+    {
         Polyline polyline = Polyline.FromString(StringValue);
 
         Decoder
@@ -40,7 +43,8 @@ public void PolylineDecoder_Decode_FromString() {
     }
 
     [Benchmark]
-    public void PolylineDecoder_Decode_FromCharArray() {
+    public void PolylineDecoder_Decode_FromCharArray()
+    {
         Polyline polyline = Polyline.FromCharArray(CharArray);
 
         Decoder
@@ -49,7 +53,8 @@ public void PolylineDecoder_Decode_FromCharArray() {
     }
 
     [Benchmark]
-    public void PolylineDecoder_Decode_FromMemory() {
+    public void PolylineDecoder_Decode_FromMemory()
+    {
         Polyline polyline = Polyline.FromMemory(Memory);
 
         Decoder

benchmarks/PolylineAlgorithm.Benchmarks/PolylineEncoderBenchmark.cs

@@ -1,6 +1,6 @@
-//  
-// Copyright (c) Pete Sramek. All rights reserved.  
-// Licensed under the MIT License. See LICENSE file in the project root for full license information.  
+//
+// Copyright © Pete Sramek. All rights reserved.
+// Licensed under the MIT License. See LICENSE file in the project root for full license information.
 //
 
 namespace PolylineAlgorithm.Benchmarks;
@@ -10,7 +10,8 @@ namespace PolylineAlgorithm.Benchmarks;
 using System.Collections.Generic;
 
 [RankColumn]
-public class PolylineEncoderBenchmark {
+public class PolylineEncoderBenchmark
+{
     private static readonly Random R = new();
 
 #pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
@@ -23,19 +24,22 @@ public class PolylineEncoderBenchmark {
     public PolylineEncoder Encoder = new();
 
     [GlobalSetup]
-    public void SetupData() {
+    public void SetupData()
+    {
         Enumeration = Enumerable.Range(0, 100).Select(i => new Coordinate(R.Next(-90, 90) + R.NextDouble(), R.Next(-180, 180) + R.NextDouble()));
         List = [.. Enumeration];
     }
 
     [Benchmark]
-    public Polyline PolylineEncoder_Encode_List() {
+    public Polyline PolylineEncoder_Encode_List()
+    {
         return Encoder
             .Encode(List!);
     }
 
     [Benchmark]
-    public Polyline PolylineEncoder_Encode_Enumerator() {
+    public Polyline PolylineEncoder_Encode_Enumerator()
+    {
         return Encoder
             .Encode(Enumeration!);
     }

benchmarks/PolylineAlgorithm.Benchmarks/Program.cs

@@ -1,15 +1,17 @@
-//  
-// Copyright (c) Pete Sramek. All rights reserved.  
-// Licensed under the MIT License. See LICENSE file in the project root for full license information.  
+//
+// Copyright © Pete Sramek. All rights reserved.
+// Licensed under the MIT License. See LICENSE file in the project root for full license information.
 //
 
 namespace PolylineAlgorithm.Benchmarks;
 
 using BenchmarkDotNet.Configs;
 using BenchmarkDotNet.Running;
 
-internal class Program {
-    static void Main(string[] args) {
+internal class Program
+{
+    static void Main(string[] args)
+    {
         BenchmarkSwitcher
             .FromAssembly(typeof(Program).Assembly)
             .Run(args, DefaultConfig.Instance);

src/PolylineAlgorithm/Coordinate.cs

@@ -17,11 +17,13 @@ namespace PolylineAlgorithm;
 /// </summary>
 [StructLayout(LayoutKind.Sequential, Pack = 8, Size = 16)]
 [DebuggerDisplay("{ToString()}")]
-public readonly struct Coordinate : IEquatable<Coordinate> {
+public readonly struct Coordinate : IEquatable<Coordinate>
+{
     /// <summary>
     /// Initializes default instance of <see cref="Coordinate"/> with <see cref="Latitude" /> and <see cref="Longitude" /> equal to 0.
     /// </summary>
-    public Coordinate() {
+    public Coordinate()
+    {
         Latitude = 0d;
         Longitude = 0d;
     }
@@ -31,7 +33,8 @@ public Coordinate() {
     /// </summary>
     /// <param name="latitude">A latitude value.</param>
     /// <param name="longitude">A latitude value.</param>
-    public Coordinate(double latitude, double longitude) {
+    public Coordinate(double latitude, double longitude)
+    {
         Latitude = latitude;
         Longitude = longitude;
     }
@@ -64,13 +67,15 @@ public bool IsValid
 
     /// <inheritdoc />
     [ExcludeFromCodeCoverage]
-    public override bool Equals(object? obj) {
+    public override bool Equals(object? obj)
+    {
         return obj is Coordinate coordinate && Equals(coordinate);
     }
 
     /// <inheritdoc />
     [ExcludeFromCodeCoverage]
-    public override int GetHashCode() {
+    public override int GetHashCode()
+    {
         return HashCode.Combine(Latitude, Longitude);
     }
 
@@ -80,7 +85,8 @@ public override int GetHashCode() {
     /// <returns>The formatted string respresentation of this instance.</returns>
     /// <remarks>{ Latitude: [double], Longitude: [double] }</remarks>
     [ExcludeFromCodeCoverage]
-    public override string ToString() {
+    public override string ToString()
+    {
         return $"{{ {nameof(Latitude)}: {Latitude.ToString("G", CultureInfo.InvariantCulture)}, {nameof(Longitude)}: {Longitude.ToString("G", CultureInfo.InvariantCulture)} }}";
     }
 
@@ -89,7 +95,8 @@ public override string ToString() {
     #region IEquatable<Coordinate> implementation
 
     /// <inheritdoc />
-    public bool Equals(Coordinate other) {
+    public bool Equals(Coordinate other)
+    {
         return Latitude == other.Latitude &&
                Longitude == other.Longitude;
     }
@@ -100,13 +107,15 @@ public bool Equals(Coordinate other) {
 
     /// <inheritdoc />
     [ExcludeFromCodeCoverage]
-    public static bool operator ==(Coordinate left, Coordinate right) {
+    public static bool operator ==(Coordinate left, Coordinate right)
+    {
         return left.Equals(right);
     }
 
     /// <inheritdoc />
     [ExcludeFromCodeCoverage]
-    public static bool operator !=(Coordinate left, Coordinate right) {
+    public static bool operator !=(Coordinate left, Coordinate right)
+    {
         return !(left == right);
     }
 

src/PolylineAlgorithm/IPolylineDecoder.cs

@@ -10,7 +10,8 @@ namespace PolylineAlgorithm;
 /// <summary>
 /// Defines method to decode a polyline.
 /// </summary>
-public interface IPolylineDecoder {
+public interface IPolylineDecoder
+{
     /// <summary>
     /// Converts an encoded polyline to a set of coordinates.
     /// </summary>

src/PolylineAlgorithm/IPolylineEncoder.cs

@@ -10,7 +10,8 @@ namespace PolylineAlgorithm;
 /// <summary>
 /// Defines method to encode a set of coordinates.
 /// </summary>
-public interface IPolylineEncoder {
+public interface IPolylineEncoder
+{
     /// <summary>
     /// Converts a set of coordinates to an encoded polyline.
     /// </summary>

src/PolylineAlgorithm/Internal/Defaults.cs

@@ -12,8 +12,10 @@ namespace PolylineAlgorithm.Internal;
 /// Defines default values
 /// </summary>
 [ExcludeFromCodeCoverage]
-internal static class Defaults {
-    public static class Algorithm {
+internal static class Defaults
+{
+    public static class Algorithm
+    {
         /// <summary>
         /// Defines the coordinate precision
         /// </summary>
@@ -43,11 +45,13 @@ public static class Algorithm {
     /// <summary>
     /// Defines coordinates default values
     /// </summary>
-    public static class Coordinate {
+    public static class Coordinate
+    {
         /// <summary>
         /// Defines latitude default values
         /// </summary>
-        public static class Latitude {
+        public static class Latitude
+        {
             /// <summary>
             /// Defines the maximum value for latitude
             /// </summary>
@@ -62,7 +66,8 @@ public static class Latitude {
         /// <summary>
         /// Defines longitude default values
         /// </summary>
-        public static class Longitude {
+        public static class Longitude
+        {
             /// <summary>
             /// Defines the maximum value for longitude
             /// </summary>
@@ -77,7 +82,8 @@ public static class Longitude {
         /// <summary>
         /// Defines default ranges for latitude and longitude
         /// </summary>
-        public static class Range {
+        public static class Range
+        {
             /// <summary>
             /// Defines latitude validation range
             /// </summary>

src/PolylineAlgorithm/Internal/PolylineReader.cs

@@ -9,15 +9,18 @@ namespace PolylineAlgorithm.Internal;
 using System.Runtime.InteropServices;
 
 [StructLayout(LayoutKind.Auto)]
-internal ref struct PolylineReader {
+internal ref struct PolylineReader
+{
     private ReaderState _state = new();
     private readonly ReadOnlySpan<char> _polyline;
 
-    public PolylineReader() {
+    public PolylineReader()
+    {
         _polyline = [];
     }
 
-    public PolylineReader(ref readonly Polyline polyline) {
+    public PolylineReader(ref readonly Polyline polyline)
+    {
         _polyline = polyline.Span;
     }
 
@@ -26,7 +29,8 @@ public PolylineReader(ref readonly Polyline polyline) {
     public readonly int Position => _state.Position;
 
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    public Coordinate Read() {
+    public Coordinate Read()
+    {
         InvalidReaderStateException.ThrowIfCannotRead(CanRead, Position, _polyline.Length);
 
         GetCurrent(out int currentLatitude, out int currentLongitude);
@@ -39,52 +43,61 @@ public Coordinate Read() {
         return new(Precise(ref latitude), Precise(ref longitude));
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        static double Precise(ref int value) {
+        static double Precise(ref int value)
+        {
             return value / Defaults.Algorithm.Precision;
         }
     }
 
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    void Advance() {
+    void Advance()
+    {
         _state.Position += 1;
     }
 
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    void SetCurrent(ref readonly int latitude, ref readonly int longitude) {
+    void SetCurrent(ref readonly int latitude, ref readonly int longitude)
+    {
         _state.Latitude = latitude;
         _state.Longitude = longitude;
     }
 
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    readonly void GetCurrent(out int latitude, out int longitude) {
+    readonly void GetCurrent(out int latitude, out int longitude)
+    {
         latitude = _state.Latitude;
         longitude = _state.Longitude;
     }
 
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    int ReadNext(ref readonly int value) {
+    int ReadNext(ref readonly int value)
+    {
         int chunk;
         int sum = 0;
         int shifter = 0;
 
-        do {
+        do
+        {
             InvalidReaderStateException.ThrowIfCannotRead(CanRead, Position, _polyline.Length);
             chunk = _polyline[Position] - Defaults.Algorithm.QuestionMark;
             sum |= (chunk & Defaults.Algorithm.UnitSeparator) << shifter;
             shifter += Defaults.Algorithm.ShiftLength;
             Advance();
         } while (chunk >= Defaults.Algorithm.Space && CanRead);
 
-        if (!CanRead && chunk >= Defaults.Algorithm.Space) {
+        if (!CanRead && chunk >= Defaults.Algorithm.Space)
+        {
             InvalidPolylineException.Throw(Position);
         }
 
         return value + ((sum & 1) == 1 ? ~(sum >> 1) : sum >> 1);
     }
 
     [StructLayout(LayoutKind.Sequential, Pack = 4, Size = 12)]
-    private ref struct ReaderState {
-        public ReaderState() {
+    private ref struct ReaderState
+    {
+        public ReaderState()
+        {
             Position = Latitude = Longitude = 0;
         }