Class: Geos::STRtree

Inherits:
Object
  • Object
show all
Includes:
Enumerable, Tools
Defined in:
lib/ffi-geos/strtree.rb

Defined Under Namespace

Classes: AlreadyBuiltError

Constant Summary

Constants included from GeomTypes

GeomTypes::GEOS_GEOMETRYCOLLECTION, GeomTypes::GEOS_LINEARRING, GeomTypes::GEOS_LINESTRING, GeomTypes::GEOS_MULTILINESTRING, GeomTypes::GEOS_MULTIPOINT, GeomTypes::GEOS_MULTIPOLYGON, GeomTypes::GEOS_POINT, GeomTypes::GEOS_POLYGON

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Tools

#bool_result, #bool_to_int, #cast_geometry_ptr, #check_enum_value, #check_geometry, #extract_options!, #pick_srid_according_to_policy, #pick_srid_from_geoms, #symbol_for_enum

Constructor Details

#initialize(*args) ⇒ STRtree

:call-seq:

new(capacity)
new(geoms_and_objects)



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/ffi-geos/strtree.rb', line 23

def initialize(*args)
  geoms_and_objects = nil # forward declaration
  capacity = 10

  if args.first.is_a?(Integer)
    capacity = args.first
  elsif args.first.is_a?(Array)
    geoms_and_objects = if args.first.first.is_a?(Array)
      args.first
    else
      args
    end

    geoms_and_objects.each do |geom, obj|
      check_geometry(geom)
    end
  end

  if capacity <= 0
    raise ArgumentError.new("STRtree capacity must be greater than 0")
  end

  ptr = FFIGeos.GEOSSTRtree_create_r(Geos.current_handle_pointer, capacity)

  @ptr = FFI::AutoPointer.new(
    ptr,
    self.class.method(:release)
  )

  @storage = {}
  @ptrs = {}

  @storage_key = 0
  @built = false

  if geoms_and_objects
    geoms_and_objects.each do |geom, obj|
      self.insert(geom, obj)
    end
  end
end

Instance Attribute Details

#ptr ⇒ Object (readonly)

Returns the value of attribute ptr.



9
10
11
 
# File 'lib/ffi-geos/strtree.rb', line 9

def ptr
  @ptr
end

Class Method Details

.release(ptr) ⇒ Object

:nodoc:



65
66
67
 
# File 'lib/ffi-geos/strtree.rb', line 65

def self.release(ptr) #:nodoc:
  FFIGeos.GEOSSTRtree_destroy_r(Geos.current_handle_pointer, ptr)
end

Instance Method Details

#built! ⇒ Object 



73
74
75
 
# File 'lib/ffi-geos/strtree.rb', line 73

def built!
  @built = true
end

#built? ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/ffi-geos/strtree.rb', line 69

def built?
  @built
end

#insert(geom, item = nil) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/ffi-geos/strtree.rb', line 82

def insert(geom, item = nil)
  if self.built?
    raise AlreadyBuiltError.new
  else
    check_geometry(geom)

    key = next_key
    key_ptr = FFI::MemoryPointer.new(:pointer)
    key_ptr.write_int(key)

    @storage[key] = {
      :item => item,
      :geometry => geom
    }
    @ptrs[key] = key_ptr

    FFIGeos.GEOSSTRtree_insert_r(Geos.current_handle_pointer, self.ptr, geom.ptr, key_ptr)
  end
end

#iterate ⇒ Object 



180
181
182
183
184
 
# File 'lib/ffi-geos/strtree.rb', line 180

def iterate
  @storage.values.each do |v|
    yield(v)
  end
end

#nearest(geom) ⇒ Object Also known as: nearest_geometry 



218
219
220
221
 
# File 'lib/ffi-geos/strtree.rb', line 218

def nearest(geom)
  item = nearest_generic(geom)
  item[:geometry] if item
end

#nearest_generic(geom) ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/ffi-geos/strtree.rb', line 187

def nearest_generic(geom)
  check_geometry(geom)

  built!

  return nil if @storage.empty?

  callback = proc { |item, _item2, distance_ptr|
    key = item.read_int
    geom_from_storage = @storage[key][:geometry]

    next 0 if geom_from_storage.empty?

    distance = geom.distance(geom_from_storage)
    distance_ptr.write_double(distance)

    next 1
  }

  key_ptr = FFIGeos.GEOSSTRtree_nearest_generic_r(
    Geos.current_handle_pointer,
    self.ptr,
    geom.ptr,
    geom.envelope.ptr,
    callback,
    nil
  )

  @storage[key_ptr.read_int] unless key_ptr.null?
end

#nearest_item(geom) ⇒ Object 



224
225
226
227
 
# File 'lib/ffi-geos/strtree.rb', line 224

def nearest_item(geom)
  item = nearest_generic(geom)
  item[:item] if item
end

#query(geom, ret = :item) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/ffi-geos/strtree.rb', line 147

def query(geom, ret = :item)
  self.query_all(geom).collect { |storage|
    item = if ret.is_a?(Array)
      storage.inject({}) do |memo, k|
        memo.tap {
          memo[k] = storage[k]
        }
      end
    elsif ret == :all
      storage
    else
      storage[ret]
    end

    item.tap {
      if block_given?
        yield(item)
      end
    }
  }.compact
end

#query_all(geom) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/ffi-geos/strtree.rb', line 120

def query_all(geom)
  check_geometry(geom)

  built!
  retval = []

  callback = proc { |*args|
    key = args.first.read_int
    storage = @storage[key]
    retval << storage

    if block_given?
      yield(storage)
    end
  }

  FFIGeos.GEOSSTRtree_query_r(
    Geos.current_handle_pointer,
    self.ptr,
    geom.ptr,
    callback,
    nil
  )

  retval
end

#query_geometries(geom) ⇒ Object Also known as: query_geoms 



169
170
171
172
173
174
175
176
177
 
# File 'lib/ffi-geos/strtree.rb', line 169

def query_geometries(geom)
  self.query_all(geom).collect { |storage|
    storage[:geometry].tap { |val|
      if block_given?
        yield(val)
      end
    }
  }.compact
end

#remove(geom, item) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/ffi-geos/strtree.rb', line 102

def remove(geom, item)
  check_geometry(geom)

  key = if storage = @storage.detect { |k, v| v[:item] == item }
    storage[0]
  end

  if key
    key_ptr = @ptrs[key]
    result = FFIGeos.GEOSSTRtree_remove_r(Geos.current_handle_pointer, self.ptr, geom.ptr, key_ptr)
    built!

    if result == 1
      @storage.delete(key)
    end
  end
end