blevesearch
diff --git a/‎.github/workflows/tests.yml
Lines changed: 24 additions & 0 deletions b/‎.github/workflows/tests.yml
Lines changed: 24 additions & 0 deletions
diff --git a/‎.golangci.yml
Lines changed: 84 additions & 0 deletions b/‎.golangci.yml
Lines changed: 84 additions & 0 deletions
diff --git a/‎README.md
Lines changed: 149 additions & 106 deletions b/‎README.md
Lines changed: 149 additions & 106 deletions
diff --git a/‎geojson/geojson_s2_util.go
Lines changed: 1 addition & 1 deletion b/‎geojson/geojson_s2_util.go
Lines changed: 1 addition & 1 deletion
@@ -0,0 +1,24 @@
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+name: Tests
+jobs:
+  test:
+    strategy:
+      matrix:
+        go-version: [1.21.x, 1.22.x, 1.23.x]
+        platform: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.platform }}
+    steps:
+    - name: Install Go
+      uses: actions/setup-go@v1
+      with:
+        go-version: ${{ matrix.go-version }}
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Test
+      run: |
+        go version
+        go test -race ./...
@@ -0,0 +1,84 @@
+version: "2"
+linters:
+  enable:
+    # Commented entries here are not enabled by default, but that we should
+    # add once the relevant lines are fixed up.
+    
+    # - errorlint # found 2 cases to be fixed.
+    # - exhaustive # found some cases that should be fixed.
+    # - exhaustruct # found some structs which missed fields in initializing.
+    # - inamedparam  # fix missing named param
+    # - makezero  # fix the unallocated elements.
+    # - misspell  # fix spelling
+    # - nlreturn  # fix these missing blank line
+    # - nonamedreturns  # found some shadowing
+    # - predeclared  # found some shadowing
+    # - revive  # detects a number of good fixes
+    # - thelper  # fix test methods with t.Testing not as first param
+    - unconvert
+    # - wastedassign  # fix and enable
+    # - whitespacew  # fix and enable
+  disable:
+    # A number of these checks run by default so they are explicitly
+    # disabled here. 
+    #
+    # Other of these checks are disabled by default, but we want to
+    # comment on why we plan to keep them excluded going forward.
+    #
+    # TODO(rsned): Move the checks to enable: once the flagged 
+    # problems are resolved for each check.
+    # https://github.com/golang/geo/issues/145
+   
+    # Enable once we reduce the cleverness with unicode chars.
+    # Identifier "ε" contain non-ASCII character: U+03B5 'ε' 
+    - asciicheck
+    # TODO(rsned): This should be enabled once we define the appropriate
+    # list of acceptable external imports.  (e.g. should only be trusted
+    # verifiable sources)
+    - depguard  
+    # Enable once we fix the detected doubled words.
+    # e.g. Duplicate words (bound) found (dupword)
+    #      // 3. Best asymptotic bound: This bound bound is derived by
+    - dupword
+    # Enable once outstanding lint bugs are fixed.
+    - errcheck     
+    # This check is not necessary as we only use types internally that we
+    # fully control so we do not expect type assertion failures.
+    - forcetypeassert 
+    # Enable once these are fixed.
+    # goconst found a few instances where repeated values could be const-ified.
+    - goconst
+    # Enable once these are fixed. 
+    # gocritic suggests a number of code cleanups to be implemented.
+    - gocritic
+    # There are too many package globals constants and types used in s2.
+    # (lookup tables and such)
+    - gochecknoglobals
+    # Enable once these are all fixed.
+    # gosec detects a bunch of unsafe integer conversions.
+    - gosec
+    # This triggers on many many of the math values chosen by S2.
+    # e.g., Magic number: 2, in <argument> detected (mnd)
+    #     math.Remainder(i.Lo-margin, 2*math.Pi),
+    # Not clear if these are every likely to be all fixed so leave
+    # this check disabled.
+    # TODO(rsned): Enable manually once in a while to look for any
+    # actually fixable cases.
+    - mnd          
+    # Triggers on most tests for failing to call paralleltest.
+    # We don't have a need to use this so keep it disabled.
+    - paralleltest 
+    # Enable once outstanding lint bugs are fixed.
+    - staticcheck   
+    # This triggers on every _test file saying they should be separate
+    # parallel packages e.g. s2->s2_test package. We do not plan to ever
+    # reshuffle the tests into a separate package.
+    - testpackage 
+    # This triggers on many parts written in advance of the code that
+    # actually calls them.  It may occasionally find some real unused
+    # code so running it by hand once in while could be useful.
+    - unused      
+formatters:
+  enable:
+    - gofmt
+    - goimports
@@ -1,4 +1,6 @@
-# Overview
+# S2 geometry library in Go
+
+[![Go Build and Test](https://github.com/golang/geo/actions/workflows/go.yml/badge.svg)](https://github.com/golang/geo/actions/workflows/go.yml) [![CodeQL](https://github.com/golang/geo/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/golang/geo/actions/workflows/github-code-scanning/codeql) [![golangci-lint](https://github.com/golang/geo/actions/workflows/golangci-lint.yml/badge.svg)](https://github.com/golang/geo/actions/workflows/golangci-lint.yml) [![OpenSSF Scorecard](https://img.shields.io/ossf-scorecard/github.com/golang/geo?label=OpenSSF%20Scorecard&style=flat)](https://scorecard.dev/viewer/?uri=github.com/golang/geo)
 
 This forked version of s2geometry implements a few essential functionalities
 like region term indexer, polygon projections etc for enabling the use of s2geo
@@ -9,7 +11,7 @@ S2 is a library for spherical geometry that aims to have the same robustness,
 flexibility, and performance as the best planar geometry libraries.
 
 This is a library for manipulating geometric shapes. Unlike many geometry
-libraries, S2 is primarily designed to work with _spherical geometry_, i.e.,
+libraries, S2 is primarily designed to work with *spherical geometry*, i.e.,
 shapes drawn on a sphere rather than on a planar 2D map. (In fact, the name S2
 is derived from the mathematical notation for the unit sphere *S²*.) This makes
 it especially suitable for working with geographic data.
@@ -84,7 +86,7 @@ to geography are not part of the core library (e.g. easting/northing
 conversions, ellipsoid approximations, geodetic vs. geocentric coordinates,
 etc).
 
-See http://godoc.org/github.com/golang/geo for specific package documentation.
+See https://pkg.go.dev/github.com/golang/geo for specific package documentation.
 
 For an analogous library in C++, see https://github.com/google/s2geometry, in
 Java, see https://github.com/google/s2-geometry-library-java, and Python, see
@@ -97,109 +99,150 @@ This library is principally a port of the
 where it makes sense. We detail the progress of this port below relative to that
 C++ library.
 
-## [ℝ¹](https://godoc.org/github.com/golang/geo/r1) - One-dimensional Cartesian coordinates
-
-Full parity with C++.
-
-## [ℝ²](https://godoc.org/github.com/golang/geo/r2) - Two-dimensional Cartesian coordinates
-
-Full parity with C++.
-
-## [ℝ³](https://godoc.org/github.com/golang/geo/r3) - Three-dimensional Cartesian coordinates
-
-Full parity with C++.
-
-## [S¹](https://godoc.org/github.com/golang/geo/s1) - Circular Geometry
-
-Full parity with C++.
-
-## [S²](https://godoc.org/github.com/golang/geo/s2) - Spherical Geometry
-
-Approximately ~40% complete.
-
-**Complete** These files have full parity with the C++ implementation.
-
-*   Cap
-*   Cell
-*   CellID
-*   CellUnion
-*   ContainsVertexQuery
-*   ConvexHullQuery
-*   CrossingEdgeQuery
-*   LatLng
-*   matrix3x3
-*   Metric
-*   PaddedCell
-*   Point
-*   PointCompression
-*   Region
-*   RegionCoverer
-*   RegionUnion
-*   RegionTermIndexer - (implemented in this fork)
-*   s2edge_clipping
-*   s2edge_crosser
-*   s2edge_crossings
-*   s2edge_distances
-*   edgeVectorShape
-*   laxLoop
-*   laxPolyline
-*   s2projections - Helpers for projecting points between R2 and S2.
-*   s2rect_bounder
-*   s2stuv.go (s2coords.h in C++) - This file is a collection of helper and
-    conversion methods to and from ST-space, UV-space, and XYZ-space.
-*   s2wedge_relations
-*   ShapeIndex
-*   idSetLexicon,sequenceLexicon
-
-**Mostly Complete** Files that have almost all of the features of the original
-C++ code, and are reasonably complete enough to use in live code. Up to date
-listing of the incomplete methods are documented at the end of each file.
-
-*   EdgeQuery/Closest/Furthest - missing Project, GetEdge
-*   ContainsPointQuery - missing visit edges
-*   laxPolygon
-*   Loop - Loop is mostly complete now. Missing Project, Distance, Union, etc.
-*   Polyline - Missing InitTo... methods, NearlyCoversPolyline
-*   Rect (AKA s2latlngrect in C++) - Missing Centroid, InteriorContains.
-*   s2_test.go (AKA s2testing and s2textformat in C++) - Missing Fractal test
-    shape generation. This file is a collection of testing helper methods.
-*   s2edge_distances - Missing Intersection
-
-**In Progress** Files that have some work done, but are probably not complete
-enough for general use in production code.
-
-*   CellIndex - A queryable index of CellIDs.
-*   Polygon - Polygons with multiple loops are supported. It fully implements
-    Shape and Region, but it's missing most other methods. (Area, Centroid,
-    Distance, Intersection, Union, Contains, Normalized, etc.)
-*   PolylineSimplifier - Initial work has begun on this.
-*   s2predicates.go - This file is a collection of helper methods used by other
-    parts of the library.
-*   s2shapeutil - Initial elements added. Missing VisitCrossings.
-
-**Not Started Yet.** These files (and their associated unit tests) have
-dependencies on most of the In Progress files before they can begin to be
-started.
-
-*   BooleanOperation - used when assembling polygons and loops.
-*   Builder - This is a robust tool for creating the various Shape types from
-    collection of simpler S2 types.
-*   BuilderClosedSetNormalizer
-*   BuilderFindPolygonDegneracies
-*   BuilderGraph
-*   BuilderLayers
-*   BuilderSnapFunctions
-*   BuilderTesting
-*   Centroids
-*   ClosestPointQuery
-*   EdgeTesselator
-*   LoopMeasures
-*   PointIndex
-*   PointRegion
-*   PointUtil
-*   PolygonMeasures
-*   RegionIntersection
-*   ShapeIndexRegion - Allows ShapeIndexes to be used as Regions for things like
+Legend:
+
+*   ✅ - Feature Complete
+*   🟡 - Mostly Complete
+*   ❌ - Not available
+
+## [ℝ¹](https://pkg.go.dev/github.com/golang/geo/r1) - One-dimensional Cartesian coordinates
+
+C++ Type   | Go
+:--------- | ---
+R1Interval | ✅
+
+## [ℝ²](https://pkg.go.dev/github.com/golang/geo/r2) - Two-dimensional Cartesian coordinates
+
+C++ Type | Go
+:------- | ---
+R2Point  | ✅
+R2Rect   | ✅
+
+## [ℝ³](https://pkg.go.dev/github.com/golang/geo/r3) - Three-dimensional Cartesian coordinates
+
+C++ Type      | Go
+:------------ | ---
+R3Vector      | ✅
+R3ExactVector | ✅
+Matrix3x3     | ✅
+
+## [S¹](https://pkg.go.dev/github.com/golang/geo/s1) - Circular Geometry
+
+C++ Type     | Go
+:----------- | ---
+S1Angle      | ✅
+S1ChordAngle | ✅
+S1Interval   | ✅
+
+## [S²](https://pkg.go.dev/github.com/golang/geo/s2) - Spherical Geometry
+
+### Basic Types
+
+C++ Type             | Go
+:------------------- | ---
+S2Cap                | ✅
+S2Cell               | ✅
+S2CellId             | ✅
+S2CellIdVector       | ❌
+S2CellIndex          | 🟡
+S2CellUnion          | ✅
+S2Coords             | ✅
+S2DensityTree        | ❌
+S2DistanceTarget     | ✅
+S2EdgeVector         | ✅
+S2LatLng             | ✅
+S2LatLngRect         | ✅
+S2LaxLoop            | 🟡
+S2LaxPolygon         | 🟡
+S2LaxPolyline        | 🟡
+S2Loop               | ✅
+S2PaddedCell         | ✅
+S2Point              | ✅
+S2PointIndex         | ❌
+S2PointSpan          | ❌
+S2PointRegion        | ❌
+S2PointVector        | ✅
+S2Polygon            | 🟡
+S2Polyline           | ✅
+S2R2Rect             | ❌
+S2Region             | ✅
+S2RegionCoverer      | ✅
+S2RegionIntersection | ❌
+S2RegionUnion        | ✅
+S2Shape              | ✅
+S2ShapeIndex         | ✅
+S2ShapeIndexRegion   | ❌
+EncodedLaxPolygon    | ❌
+EncodedLaxPolyline   | ❌
+EncodedShapeIndex    | ❌
+EncodedStringVector  | ❌
+EncodedUintVector    | ❌
+IdSetLexicon         | ❌
+ValueSetLexicon      | ❌
+SequenceLexicon      | ❌
+LaxClosedPolyline    | ❌
+VertexIDLaxLoop      | ❌
+
+### Query Types
+
+C++ Type             | Go
+:------------------- | ---
+S2ChainInterpolation | ❌
+S2ClosestCell        | ❌
+S2FurthestCell       | ❌
+S2ClosestEdge        | ✅
+S2FurthestEdge       | ✅
+S2ClosestPoint       | ❌
+S2FurthestPoint      | ❌
+S2ContainsPoint      | ✅
+S2ContainsVertex     | ✅
+S2ConvexHull         | ✅
+S2CrossingEdge       | ✅
+S2HausdorffDistance  | ❌
+S2ShapeNesting       | ❌
+
+### Supporting Types
+
+C++ Type                         | Go
+:------------------------------- | ---
+S2BooleanOperation               | ❌
+S2BufferOperation                | ❌
+S2Builder                        | ❌
+S2BuilderClosedSetNormalizer     | ❌
+S2BuilderFindPolygonDegeneracies | ❌
+S2BuilderGraph                   | ❌
+S2BuilderLayers                  | ❌
+S2BuilderSnapFunctions           | ❌
+S2BuilderTesting                 | ❌
+S2Builderutil\*                  | ❌
+S2Coder                          | ❌
+S2EdgeClipping                   | ✅
+S2EdgeCrosser                    | ✅
+S2EdgeCrossings                  | ✅
+S2EdgeDistances                  | ✅
+S2EdgeTessellator                | ✅
+S2LoopMeasures                   | ❌
+S2Measures                       | ✅
+S2MemoryTracker                  | ❌
+S2Metrics                        | ❌
+S2PointUtil                      | 🟡
+S2PolygonBuilder                 | ❌
+S2PolylineAlignment              | ❌
+S2PolylineMeasures               | ✅
+S2PolylineSimplifier             | ❌
+S2Predicates                     | ✅
+S2Projections                    | ❌
+S2rectBounder                    | ❌
+S2RegionTermIndexer              | ❌
+S2ShapeIndexMeasures             | ❌
+S2ShapeIndexUtil\*               | 🟡
+S2ShapeMeasures                  | ❌
+S2ShapeUtil\*                    | 🟡
+S2Stats                          | ❌
+S2Testing                        | ✅
+S2TextFormat                     | ✅
+S2WedgeRelations                 | ✅
+S2WindingOperation               | ❌
 
 ### Encode/Decode
 
 
@@ -20,7 +20,7 @@ import (
 
 	index "github.com/blevesearch/bleve_index_api"
 	"github.com/blevesearch/geo/s2"
-	"github.com/golang/geo/s1"
+	"github.com/blevesearch/geo/s1"
 )
 
 // ------------------------------------------------------------------------
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ import (`
`20`	`20`
`21`	`21`	`index "github.com/blevesearch/bleve_index_api"`
`22`	`22`	`"github.com/blevesearch/geo/s2"`
`23`		`- "github.com/golang/geo/s1"`
	`23`	`+ "github.com/blevesearch/geo/s1"`
`24`	`24`	`)`
`25`	`25`
`26`	`26`	`// ------------------------------------------------------------------------`