Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add incidentEdgeTracker and indexCellData types and tests #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Add incidentEdgeTracker and indexCellData types and tests #180

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
40abfda
Add incidentEdgeTracker and indexCellData types and tests
rsned May 15, 2025
db83ebf
remove some extraneous bits
rsned May 15, 2025
394b634
Fix LaxPolygon to properly order vertices between shells and holes.
rsned May 16, 2025
8aa64ba
Merge branch 'golang:master' into internal
rsned Jul 5, 2025
475ef64
Update s2/index_cell_data.go
rsned Jul 5, 2025
2b1704c
Update s2/index_cell_data_test.go
rsned Jul 5, 2025
9dd01a8
Add missing body for laxPolygonFromLoops and missing test messages.
rsned Jul 5, 2025
d1c19d1
Merge branch 'internal' of ssh://github.com/rsned/geo into internal
rsned Jul 5, 2025
cbe002a
Update index_cell_data with review requests. Updated tests.
rsned Jul 5, 2025
8e8bb75
Updated comments based on Javas clearer comments.
rsned Jul 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update index_cell_data with review requests. Updated tests.
  • Loading branch information
@rsned
rsned committed Jul 5, 2025
commit cbe002a1a175fa60aa9b64686d5b7368178a7217
101 changes: 45 additions & 56 deletions s2/index_cell_data.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,17 @@

package s2

import (
"sync"
"sync/atomic"
)

// indexCellRegion represents a simple pair for defining an integer valued region.
type indexCellRegion struct {
// indexCellRange represents a simple pair for defining an integer valued range.
type indexCellRange struct {
start int
size int
}

// shapeRegion is a mapping from shape id to the region of the edges array
// shapeRange is a mapping from shapeID to the range of the edges array
// it's stored in.
type shapeRegion struct {
id int32
region indexCellRegion
type shapeRange struct {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this one too generic? Would indexShapeRange be better?

id int32
cellRange indexCellRange
}

// edgeAndIDChain is an extension of Edge with fields for the edge id,
Expand Down Expand Up @@ -82,16 +77,16 @@ type edgeAndIDChain struct {
// shapes _within a dimension_ are in the same order they are in the index
// itself, and the edges _within a shape_ are similarly in the same order.
type indexCellData struct {
// index is the ShapeIndex the currently loaded Cell belongs to.
index *ShapeIndex
indexCell *ShapeIndexCell
cellID CellID

// Computing the cell center and Cell can cost as much as looking up the
// edges themselves, so defer doing it until needed.
mu sync.Mutex
s2CellSet atomic.Bool
s2CellSet bool
s2Cell Cell
centerSet atomic.Bool
centerSet bool
cellCenter Point

// Dimensions that we wish to decode, the default is all of them.
Expand All @@ -100,11 +95,11 @@ type indexCellData struct {
// Storage space for edges of the current cell.
edges []edgeAndIDChain

// Mapping from shape id to the region of the edges array it's stored in.
shapeRegions []shapeRegion
// Mapping from shape id to the ranges of the edges array it's stored in.
shapeRanges []shapeRange

// Region for each dimension we might encounter.
dimRegions [3]indexCellRegion
// Range for each dimension we might encounter.
dimRanges [3]indexCellRange
}

// newIndexCellData creates a new indexCellData with the expected defaults.
Expand All @@ -129,7 +124,7 @@ func (d *indexCellData) reset() {
d.index = nil
d.indexCell = nil
d.edges = d.edges[:0]
d.shapeRegions = d.shapeRegions[:0]
d.shapeRanges = d.shapeRanges[:0]
d.dimWanted = [3]bool{true, true, true}
}

Expand All @@ -144,27 +139,21 @@ func (d *indexCellData) setDimWanted(dim int, wanted bool) {
// cell returns the S2 Cell for the current index cell, loading it if it
// was not already set.
func (d *indexCellData) cell() Cell {
if !d.s2CellSet.Load() {
d.mu.Lock()
if !d.s2CellSet.Load() {
d.s2Cell = CellFromCellID(d.cellID)
d.s2CellSet.Store(true)
}
d.mu.Unlock()
// TODO(rsned): Consider if we need to add mutex here for thread safety.
if !d.s2CellSet {
d.s2Cell = CellFromCellID(d.cellID)
d.s2CellSet = true
}
return d.s2Cell
}

// center returns the center point of the current index cell, loading it
// if it was not already set.
func (d *indexCellData) center() Point {
if !d.centerSet.Load() {
d.mu.Lock()
if !d.centerSet.Load() {
d.cellCenter = d.cellID.Point()
d.centerSet.Store(true)
}
d.mu.Unlock()
// TODO(rsned): Consider if we need to add mutex here for thread safety.
if !d.centerSet {
d.cellCenter = d.cellID.Point()
d.centerSet = true
}
return d.cellCenter
}
Expand All @@ -177,7 +166,7 @@ func (d *indexCellData) center() Point {
// loadCell, loading is not performed since we already have the data decoded.
func (d *indexCellData) loadCell(index *ShapeIndex, id CellID, cell *ShapeIndexCell) {
// If this is still the same ShapeIndexCell as last time, then we are good.
if d.index == index && d.cellID == id {
if d.index == index && d.cellID == id && cell == d.indexCell {
return
}

Expand All @@ -187,17 +176,17 @@ func (d *indexCellData) loadCell(index *ShapeIndex, id CellID, cell *ShapeIndexC
d.indexCell = cell
d.cellID = id

// Reset atomic flags so we'll recompute cached values.
d.s2CellSet.Store(false)
d.centerSet.Store(false)
// Reset flags so we'll recompute cached values.
d.s2CellSet = false
d.centerSet = false

// Clear previous edges
d.edges = d.edges[:0]
d.shapeRegions = d.shapeRegions[:0]
d.shapeRanges = d.shapeRanges[:0]

// Reset per-dimension region information.
for i := range d.dimRegions {
d.dimRegions[i] = indexCellRegion{}
// Reset per-dimension range information.
for i := range d.dimRanges {
d.dimRanges[i] = indexCellRange{}
}

minDim := 0
Expand Down Expand Up @@ -239,7 +228,7 @@ func (d *indexCellData) loadCell(index *ShapeIndex, id CellID, cell *ShapeIndexC

// Materialize clipped shape edges into the edges
// slice. Track where we start so we can add
// information about the region for this shape.
// information about the range for this shape.
shapeStart := len(d.edges)
for _, edgeID := range clipped.edges {
// Looking up an edge requires looking up
Expand All @@ -258,17 +247,17 @@ func (d *indexCellData) loadCell(index *ShapeIndex, id CellID, cell *ShapeIndexC
}

// Note which block of edges belongs to the shape.
d.shapeRegions = append(d.shapeRegions, shapeRegion{
d.shapeRanges = append(d.shapeRanges, shapeRange{
id: shapeID,
region: indexCellRegion{
cellRange: indexCellRange{
start: shapeStart,
size: len(d.edges) - shapeStart,
},
})
}

// Save region information for the current dimension.
d.dimRegions[dim] = indexCellRegion{
// Save range information for the current dimension.
d.dimRanges[dim] = indexCellRange{
start: dimStart,
size: len(d.edges) - dimStart,
}
Expand All @@ -277,11 +266,11 @@ func (d *indexCellData) loadCell(index *ShapeIndex, id CellID, cell *ShapeIndexC

// shapeEdges returns a slice of the edges in the current cell for a given shape.
func (d *indexCellData) shapeEdges(shapeID int32) []edgeAndIDChain {
for _, sr := range d.shapeRegions {
for _, sr := range d.shapeRanges {
if sr.id == shapeID {
region := sr.region
if region.start < len(d.edges) {
return d.edges[region.start : region.start+region.size]
cellRange := sr.cellRange
if cellRange.start < len(d.edges) {
return d.edges[cellRange.start : cellRange.start+cellRange.size]
}
return nil
}
Expand All @@ -296,9 +285,9 @@ func (d *indexCellData) dimEdges(dim int) []edgeAndIDChain {
return nil
}

region := d.dimRegions[dim]
if region.start < len(d.edges) {
return d.edges[region.start : region.start+region.size]
dimRange := d.dimRanges[dim]
if dimRange.start < len(d.edges) {
return d.edges[dimRange.start : dimRange.start+dimRange.size]
}
return nil
}
Expand All @@ -310,12 +299,12 @@ func (d *indexCellData) dimRangeEdges(dim0, dim1 int) []edgeAndIDChain {
return nil
}

start := d.dimRegions[dim0].start
start := d.dimRanges[dim0].start
size := 0

for dim := dim0; dim <= dim1; dim++ {
start = minInt(start, d.dimRegions[dim].start)
size += d.dimRegions[dim].size
start = minInt(start, d.dimRanges[dim].start)
size += d.dimRanges[dim].size
}

if start < len(d.edges) {
Expand Down
28 changes: 21 additions & 7 deletions s2/index_cell_data_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,32 @@ import (
"testing"
)

func TestIndexCellDataDefaultsDimensionFilteringWorks(t *testing.T) {
// Separate test for default dimensions so we aren't setting them explicitly.
index := makeShapeIndex("0:0" +
"#1:1, 2:2" +
"#1:0, 0:1, -1:0, 0:-1")

iter := index.Iterator()
iter.Begin()
data := newIndexCellData()
data.loadCell(index, iter.CellID(), iter.cell)

for dim := 0; dim < 2; dim++ {
// All three dimensions should have data.
if len(data.dimEdges(dim)) == 0 {
t.Errorf("Expected non-empty dimEdges(%d), but got empty", dim)
}
}
}

// TestIndexCellDataDimensionFilteringWorks verifies that we can filter
// shapes by dimension when loading cells.
func testIndexCellDataDimensionFilteringWorks(t *testing.T) {
func TestIndexCellDataDimensionFilteringWorks(t *testing.T) {
tests := []struct {
dimWanted [3]bool
dimEmpty [3]bool
}{
{
// Check that we get all dimensions by default.
dimWanted: [3]bool{true, true, true},
dimEmpty: [3]bool{false, false, false},
},
{
// No dimensions should work too, we just don't decode edges.
dimWanted: [3]bool{false, false, false},
Expand Down Expand Up @@ -107,7 +121,7 @@ func testIndexCellDataDimensionFilteringWorks(t *testing.T) {
// TestIndexCellDataCellAndCenterRecomputed verifies that when we load a
// new unique cell, the cached cell and center values are updated if we
// access them.
func testIndexCellDataCellAndCenterRecomputed(t *testing.T) {
func TestIndexCellDataCellAndCenterRecomputed(t *testing.T) {
// A line between two faces will guarantee we get at least two cells.
index := makeShapeIndex("# 0:0, 0:-90 #")

Expand Down