Merge branch 'develop'

* develop: (89 commits)
  Updated examples
  Removed all of unused ones
  Deleted the unused argument.
  move function to utils
  fix min index calculation
  make function public
  account for negative indicies
  edit variable names, comments
  add explanations
  remove unused type
  remove unused functions
  simplify convertVerticalIndex
  add verticalIndexOffset and helper functions
  change to lowercase
  edit comments
  add arithmetic shift
  adjust test for newly named functions
  add get functions
  add comment
  rename function and implement new return type
  ...

common/object/coordinate.go

@@ -4,7 +4,7 @@ package object
 import (
 	"math"
 
-	"github.com/trajectoryjp/spatial_id_go/v2/common/errors"
+	"github.com/trajectoryjp/spatial_id_go/v3/common/errors"
 )
 
 // Point 地理座標用の構造体

common/object/id_object.go

@@ -1,6 +1,153 @@
 // 拡張空間IDパッケージ
 package object
 
+// FromExtendedSpatialIDToQuadkeyAndAltitudekey 拡張空間IDから変換したquadkeyと標高のIDの組み合わせを管理する構造体
+type FromExtendedSpatialIDToQuadkeyAndAltitudekey struct {
+	// quadkey zoom level / quadkeyの精度
+	quadkeyZoom int64
+	// a list of quadkey-altitude key sets [[quadkey, altitudekey]...]
+	innerIDList [][2]int64
+	// altitudekey zoom level / 高さ方向の精度
+	altitudekeyZoom int64
+	// altitude range scalar is s, where 2^25-s = altitude range (max altitude - min altitude)
+	altitudeRangeScalar int64
+	// shifts the altitude range up or down by n units of the resulting verticalIndex
+	verticalIndexOffset int64
+}
+
+// NewFromExtendedSpatialIDToQuadkeyAndVerticalID FromExtendedSpatialIDToQuadkeyAndVerticalID初期化関数
+//
+// input 引数：
+//
+//	quadkeyZoom： quadkey zoom level / quadkeyの精度
+//	innerIDList: [[quadkey,vIndex]...]
+//	altitudekeyZoom: // altitudekey zoom level / 高さ方向の精度
+//	altitudeRangeScalar: altitude range scalar is s, where 2^25-s = altitude range (max altitude - min altitude)
+//	verticalIndexOffset : shifts the altitude range up or down by n units of the resulting verticalIndex
+//
+// output 戻り値：
+//
+//	初期化したFromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクト
+func NewFromExtendedSpatialIDToQuadkeyAndAltitudekey(quadkeyZoom int64, innerIDList [][2]int64, altitudekeyZoom int64, altitudeRangeScalar int64, verticalIndexOffset int64) *FromExtendedSpatialIDToQuadkeyAndAltitudekey {
+	a := &FromExtendedSpatialIDToQuadkeyAndAltitudekey{}
+	a.SetQuadkeyZoom(quadkeyZoom)
+	a.SetInnerIDList(innerIDList)
+	a.SetVerticalZoom(altitudekeyZoom)
+	a.SetAltitudeRangeScalar(altitudeRangeScalar)
+	a.SetVerticalIndexOffset(verticalIndexOffset)
+	return a
+}
+
+// SetQuadkeyZoom 水平精度設定関数
+//
+// FromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクトのquadkeyZoomを引数の入力値に設定する。
+//
+// input 引数：
+//
+//	quadkeyZoom：quadkeyの精度
+func (a *FromExtendedSpatialIDToQuadkeyAndAltitudekey) SetQuadkeyZoom(quadkeyZoom int64) {
+	a.quadkeyZoom = quadkeyZoom
+}
+
+// SetInnerIDList innerIDList設定関数
+//
+// FromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクトのinnerIDListを引数の入力値に設定する。
+//
+// input 引数：
+//
+//	innerIDList：innerIDListのスライス
+func (a *FromExtendedSpatialIDToQuadkeyAndAltitudekey) SetInnerIDList(innerIDList [][2]int64) {
+	a.innerIDList = innerIDList
+}
+
+// SetVerticalZoom 垂直精度設定関数
+//
+// FromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクトのVerticalZoomを引数の入力値に設定する。
+//
+// input 引数：
+//
+//	vZoom：垂直精度
+func (a *FromExtendedSpatialIDToQuadkeyAndAltitudekey) SetVerticalZoom(altitudekeyZoom int64) {
+	a.altitudekeyZoom = altitudekeyZoom
+}
+
+// SetAltitudeRangeScalar
+//
+// FromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクトのVerticalZoomを引数の入力値に設定する。
+//
+// input 引数：
+//
+//	altitudeRangeScalar
+func (a *FromExtendedSpatialIDToQuadkeyAndAltitudekey) SetAltitudeRangeScalar(aScalar int64) {
+	a.altitudeRangeScalar = aScalar
+}
+
+// SetVerticalIndexOffset
+//
+// FromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクトのVerticalZoomを引数の入力値に設定する。
+//
+// input 引数：
+//
+//	vZoom：垂直精度
+func (a *FromExtendedSpatialIDToQuadkeyAndAltitudekey) SetVerticalIndexOffset(verticalIndexOffset int64) {
+	a.verticalIndexOffset = verticalIndexOffset
+}
+
+// QuadkeyZoom QuadkeyZoom設定値取得関数
+//
+// FromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクトに設定されているquadkeyZoomの値を取得する。
+//
+// output 戻り値：
+//
+//	FromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクトに設定されているquadkeyZoomの値
+func (a *FromExtendedSpatialIDToQuadkeyAndAltitudekey) QuadkeyZoom() int64 {
+	return a.quadkeyZoom
+}
+
+// InnerIDList InnerIDList設定値取得関数
+//
+// FromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクトに設定されているInnerIDListの値を取得する。
+//
+// output 戻り値：
+//
+//	FromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクトに設定されているInnerIDListの値
+func (a *FromExtendedSpatialIDToQuadkeyAndAltitudekey) InnerIDList() [][2]int64 {
+	return a.innerIDList
+}
+
+// AltitudekeyZoom AltitudekeyZoom設定値取得関数
+//
+// FromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクトに設定されているAltitudekeyZoomの値を取得する。
+//
+// output 戻り値：
+//
+//	FromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクトに設定されているAltitudekeyZoomの値
+func (a *FromExtendedSpatialIDToQuadkeyAndAltitudekey) AltitudekeyZoom() int64 {
+	return a.altitudekeyZoom
+}
+
+// AltitudeRangeScalar AltitudeRangeScalar設定値取得関数
+//
+// FromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクトに設定されているAltitudeRangeScalarの値を取得する。
+//
+// output 戻り値：
+//
+//	FromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクトに設定されているAltitudeRangeScalarの値
+func (a *FromExtendedSpatialIDToQuadkeyAndAltitudekey) AltitudeRangeScalar() int64 {
+	return a.altitudeRangeScalar
+}
+
+// VerticalIndexOffset VerticalIndexOffset設定値取得関数
+//
+// FromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクトに設定されているVerticalIndexOffsetの値を取得する。
+//
+// output 戻り値：
+//
+//	FromExtendedSpatialIDToQuadkeyAndAltitudekeyオブジェクトに設定されているVerticalIndexOffsetの値
+func (a *FromExtendedSpatialIDToQuadkeyAndAltitudekey) VerticalIndexOffset() int64 {
+	return a.verticalIndexOffset
+}
+
 // FromExtendedSpatialIDToQuadkeyAndVerticalID 拡張空間IDから変換したquadkeyと高さのIDの組み合わせを管理する構造体
 type FromExtendedSpatialIDToQuadkeyAndVerticalID struct {
 	// quadkeyの精度

common/object/spatial_id.go

@@ -5,8 +5,8 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/trajectoryjp/spatial_id_go/v2/common/consts"
-	"github.com/trajectoryjp/spatial_id_go/v2/common/errors"
+	"github.com/trajectoryjp/spatial_id_go/v3/common/consts"
+	"github.com/trajectoryjp/spatial_id_go/v3/common/errors"
 )
 
 // ExtendedSpatialID 拡張空間IDクラス

common/spatial/point3.go

@@ -2,8 +2,8 @@
 package spatial
 
 import (
-	"github.com/trajectoryjp/spatial_id_go/v2/common"
-	"github.com/trajectoryjp/spatial_id_go/v2/common/errors"
+	"github.com/trajectoryjp/spatial_id_go/v3/common"
+	"github.com/trajectoryjp/spatial_id_go/v3/common/errors"
 )
 
 // UniqueAppend 点のユニークを保持した配列追加

common/spatial/quat.go

@@ -4,7 +4,7 @@ package spatial
 import (
 	"math"
 
-	"github.com/trajectoryjp/spatial_id_go/v2/common/consts"
+	"github.com/trajectoryjp/spatial_id_go/v3/common/consts"
 )
 
 // Quat 四元数の構造体

common/spatial/quat_test.go

@@ -3,8 +3,8 @@ package spatial
 import (
 	"testing"
 
-	"github.com/trajectoryjp/spatial_id_go/v2/common"
-	"github.com/trajectoryjp/spatial_id_go/v2/common/consts"
+	"github.com/trajectoryjp/spatial_id_go/v3/common"
+	"github.com/trajectoryjp/spatial_id_go/v3/common/consts"
 )
 
 // TestQuat 四元数の構造体(試験用)

common/util.go

@@ -4,7 +4,7 @@ package common
 import (
 	"math"
 
-	"github.com/trajectoryjp/spatial_id_go/v2/common/errors"
+	"github.com/trajectoryjp/spatial_id_go/v3/common/errors"
 )
 
 // AlmostEqual 同値確認関数
@@ -322,3 +322,16 @@ func Combinations(n, k int64, f func([]int64)) {
 		}
 	}
 }
+
+// computes arithmatic shift of index and shift parameters. When index = 1, similar to returning 2^shift. When index > 1,
+// similar to returning index*2^shift.
+func CalculateArithmeticShift(index int64, shift int64) int64 {
+
+	// determine if shift is non-negative
+	if shift >= 0 {
+		return index << shift
+	} else {
+		return index >> -shift
+	}
+
+}

common/util_test.go

@@ -1051,3 +1051,27 @@ func contains(slice []int, target int) bool {
 	}
 	return false
 }
+
+func TestCalculateArithmaticShift(t *testing.T) {
+	data := []struct {
+		index          int64
+		shift          int64
+		expectedOutput int64
+	}{
+		{index: 1, shift: 25, expectedOutput: 33554432},
+		{index: 1, shift: 23, expectedOutput: 8388608},
+		{index: 1, shift: 0, expectedOutput: 1},
+		{index: 47, shift: 0, expectedOutput: 47},
+		{index: 47, shift: -1, expectedOutput: 23},
+		{index: 47, shift: -100, expectedOutput: 0},
+		{index: 123456, shift: -1, expectedOutput: 61728},
+	}
+
+	for _, p := range data {
+		result := CalculateArithmeticShift(p.index, p.shift)
+		if result != p.expectedOutput {
+			t.Log(t.Name())
+			t.Errorf("calculateMinVerticalIndex(%v, %v) == %v, result: %v", p.index, p.shift, p.expectedOutput, result)
+		}
+	}
+}

examples/checkZoom/README.md

@@ -1,23 +1,6 @@
 ## 手順
 
-1. .netrcを生成します
-   ```
-   echo "machine github.com" > ~/.netrc \
-   && echo "login <GitHubのユーザー名>" >> ~/.netrc \
-   && echo "password <GitHubのアクセストークン>" >> ~/.netrc
-   ```
-
-2. GOPRIVATEを登録します
-   ```
-   export GOPRIVATE=github.com,direct
-   ```
-
-3. モジュールを更新します
-   ```
-   go mod tidy -e
-   ```
-
-4. 下記、コマンドでmain.goを実行します。
+1. 下記、コマンドでmain.goを実行します。
    ```
    go run main.go
-   ```
+   ```

examples/checkZoom/go.mod

@@ -2,12 +2,9 @@ module checkZoom
 
 go 1.20
 
-require github.com/trajectoryjp/spatial_id_go v2.0.0
+require github.com/trajectoryjp/spatial_id_go/v3 v3.0.0
 
 require (
 	github.com/wroge/wgs84 v1.1.7 // indirect
-	go.uber.org/atomic v1.7.0 // indirect
-	go.uber.org/multierr v1.6.0 // indirect
-	go.uber.org/zap v1.24.0 // indirect
 	gonum.org/v1/gonum v0.13.0 // indirect
 )

examples/checkZoom/go.sum

@@ -1,25 +1,7 @@
-github.com/benbjohnson/clock v1.1.0 h1:Q92kusRqC1XV2MjkWETPvjJVqKetz1OzxZB7mHJLju8=
-github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
-github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
-github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
-github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
-github.com/stretchr/testify v1.8.0 h1:pSgiaMZlXftHpm5L7V1+rVB+AZJydKsMxsQBIJw4PKk=
-github.com/trajectoryjp/spatial_id_go v1.0.0 h1:CxR4RxQx/HotIQpyGxo5cS1F+OzeX6ENA1iM2ct2HJE=
-github.com/trajectoryjp/spatial_id_go v1.0.0/go.mod h1:O+C0j6urPB/b72rVCP52zndqE1lytE/4hz4rNEYgzPg=
+github.com/trajectoryjp/spatial_id_go/v2 v2.0.0 h1:AZkQkIrsOV6IYFPheoDkTiRYSdoARCw0HQe5cfhWci8=
+github.com/trajectoryjp/spatial_id_go/v2 v2.0.0/go.mod h1:XEDPqIuIatdNOE08aoZ+jQKf3YPMS57WA2pbrD/3GTE=
 github.com/wroge/wgs84 v1.1.7 h1:8WVUUrpjysYxrn0ssWX7z90SOUKCuHt9NQ5tg9ovjIY=
 github.com/wroge/wgs84 v1.1.7/go.mod h1:mc1F8ubW03DO4zaf/006cmhaiMlfvbKmqVAcPuAtsNA=
-go.uber.org/atomic v1.7.0 h1:ADUqmZGgLDDfbSL9ZmPxKTybcoEYHgpYfELNoN+7hsw=
-go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc=
-go.uber.org/goleak v1.1.11 h1:wy28qYRKZgnJTxGxvye5/wgWr1EKjmUDGYox5mGlRlI=
-go.uber.org/multierr v1.6.0 h1:y6IPFStTAIT5Ytl7/XYmHvzXQ7S3g/IeZW9hyZ5thw4=
-go.uber.org/multierr v1.6.0/go.mod h1:cdWPpRnG4AhwMwsgIHip0KRBQjJy5kYEpYjJxpXp9iU=
-go.uber.org/zap v1.24.0 h1:FiJd5l1UOLj0wCgbSE0rwwXHzEdAZS6hiiSnxJN/D60=
-go.uber.org/zap v1.24.0/go.mod h1:2kMP+WWQ8aoFoedH3T2sq6iJ2yDWpHbP0f6MQbS9Gkg=
 golang.org/x/exp v0.0.0-20230321023759-10a507213a29 h1:ooxPy7fPvB4kwsA2h+iBNHkAbp/4JxTSwCmvdjEYmug=
 gonum.org/v1/gonum v0.13.0 h1:a0T3bh+7fhRyqeNbiC3qVHYmkiQgit3wnNan/2c0HMM=
 gonum.org/v1/gonum v0.13.0/go.mod h1:/WPYRckkfWrhWefxyYTfrTtQR0KH4iyHNuzxqXAKyAU=
-gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

examples/checkZoom/main.go

@@ -3,7 +3,7 @@ package main
 import (
 	"fmt"
 
-	"github.com/trajectoryjp/spatial_id_go/v2/shape"
+	"github.com/trajectoryjp/spatial_id_go/v3/shape"
 )
 
 func main() {

go.mod

@@ -1,4 +1,4 @@
-module github.com/trajectoryjp/spatial_id_go/v2
+module github.com/trajectoryjp/spatial_id_go/v3
 
 go 1.19
 
@@ -11,8 +11,4 @@ require (
 
 require golang.org/x/image v0.7.0 // indirect
 
-require (
-	github.com/trajectoryjp/closest_go v1.0.1
-	go.uber.org/atomic v1.7.0 // indirect
-	go.uber.org/multierr v1.6.0 // indirect
-)
+require github.com/trajectoryjp/closest_go v1.0.1

go.sum

@@ -1,15 +1,5 @@
-github.com/benbjohnson/clock v1.1.0 h1:Q92kusRqC1XV2MjkWETPvjJVqKetz1OzxZB7mHJLju8=
-github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
-github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/go-gl/mathgl v1.1.0 h1:0lzZ+rntPX3/oGrDzYGdowSLC2ky8Osirvf5uAwfIEA=
 github.com/go-gl/mathgl v1.1.0/go.mod h1:yhpkQzEiH9yPyxDUGzkmgScbaBVlhC06qodikEM0ZwQ=
-github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
-github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
-github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
-github.com/stretchr/testify v1.8.0 h1:pSgiaMZlXftHpm5L7V1+rVB+AZJydKsMxsQBIJw4PKk=
 github.com/trajectoryjp/closest_go v1.0.1 h1:dvshtZzPDwhGDhzn5SVZxlgNnqr/gLp4uIpGDIEOHaU=
 github.com/trajectoryjp/closest_go v1.0.1/go.mod h1:+iTxW7/pOi0dIqo2/GcqGqWh/fAj2gMjDIiZ+BFDXIc=
 github.com/trajectoryjp/geodesy_go v1.0.1 h1:FvvnA3kPcPoXOjn6cS27R9aiCLyszOarFuZRVlQRG2s=
@@ -18,13 +8,6 @@ github.com/wroge/wgs84 v1.1.7 h1:8WVUUrpjysYxrn0ssWX7z90SOUKCuHt9NQ5tg9ovjIY=
 github.com/wroge/wgs84 v1.1.7/go.mod h1:mc1F8ubW03DO4zaf/006cmhaiMlfvbKmqVAcPuAtsNA=
 github.com/xieyuschen/deepcopy v1.0.1 h1:nTCnKprCOdibz8WXWlMZzULIlpzZX0ZzKjz8HlGd/Nk=
 github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
-go.uber.org/atomic v1.7.0 h1:ADUqmZGgLDDfbSL9ZmPxKTybcoEYHgpYfELNoN+7hsw=
-go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc=
-go.uber.org/goleak v1.1.11 h1:wy28qYRKZgnJTxGxvye5/wgWr1EKjmUDGYox5mGlRlI=
-go.uber.org/multierr v1.6.0 h1:y6IPFStTAIT5Ytl7/XYmHvzXQ7S3g/IeZW9hyZ5thw4=
-go.uber.org/multierr v1.6.0/go.mod h1:cdWPpRnG4AhwMwsgIHip0KRBQjJy5kYEpYjJxpXp9iU=
-go.uber.org/zap v1.24.0 h1:FiJd5l1UOLj0wCgbSE0rwwXHzEdAZS6hiiSnxJN/D60=
-go.uber.org/zap v1.24.0/go.mod h1:2kMP+WWQ8aoFoedH3T2sq6iJ2yDWpHbP0f6MQbS9Gkg=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
 golang.org/x/exp v0.0.0-20230321023759-10a507213a29 h1:ooxPy7fPvB4kwsA2h+iBNHkAbp/4JxTSwCmvdjEYmug=

integrate/change_zoom.go

@@ -6,10 +6,10 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/trajectoryjp/spatial_id_go/v2/common"
-	"github.com/trajectoryjp/spatial_id_go/v2/common/errors"
-	"github.com/trajectoryjp/spatial_id_go/v2/common/object"
-	"github.com/trajectoryjp/spatial_id_go/v2/shape"
+	"github.com/trajectoryjp/spatial_id_go/v3/common"
+	"github.com/trajectoryjp/spatial_id_go/v3/common/errors"
+	"github.com/trajectoryjp/spatial_id_go/v3/common/object"
+	"github.com/trajectoryjp/spatial_id_go/v3/shape"
 )
 
 // ChangeSpatialIdsZoom 空間IDの精度変換関数