Class: Ngt::Index

Inherits:
Object
  • Object
show all
Includes:
Utils
Defined in:
lib/ngt/index.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(index, path) ⇒ Index

Returns a new instance of Index.



7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/ngt/index.rb', line 7

def initialize(index, path)
  @index = index
  @path = path

  @error = FFI.ngt_create_error_object
  FFI.add_finalizer(@error, :ngt_destroy_error_object)

  @property = ffi(:ngt_create_property)
  FFI.add_finalizer(@property, :ngt_destroy_property)
  ffi(:ngt_get_property, @index, @property)
end

Instance Attribute Details

#path ⇒ Object (readonly)

Returns the value of attribute path.



5
6
7
 
# File 'lib/ngt/index.rb', line 5

def path
  @path
end

Class Method Details

.create(path, dimensions, **options) ⇒ Object 



193
194
195
196
 
# File 'lib/ngt/index.rb', line 193

def self.create(path, dimensions, **options)
  warn "[ngt] create is deprecated - use new instead"
  new(dimensions, path: path, **options)
end

.ffi(*args) ⇒ Object

private



199
200
201
 
# File 'lib/ngt/index.rb', line 199

def self.ffi(*args)
  Utils.ffi(*args)
end

.load(path) ⇒ Object 



189
190
191
 
# File 'lib/ngt/index.rb', line 189

def self.load(path)
  new(nil, path: path)
end

.new(dimensions, path: nil, edge_size_for_creation: 10, edge_size_for_search: 40, object_type: :float, distance_type: :l2) ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/ngt/index.rb', line 128

def self.new(dimensions, path: nil, edge_size_for_creation: 10,
    edge_size_for_search: 40, object_type: :float, distance_type: :l2)

  error = FFI.ngt_create_error_object

  if path && dimensions.nil?
    index = ffi(:ngt_open_index, path, error)
  else
    property = ffi(:ngt_create_property, error)
    ffi(:ngt_set_property_dimension, property, dimensions, error)
    ffi(:ngt_set_property_edge_size_for_creation, property, edge_size_for_creation, error)
    ffi(:ngt_set_property_edge_size_for_search, property, edge_size_for_search, error)

    case object_type.to_s.downcase
    when "float"
      ffi(:ngt_set_property_object_type_float, property, error)
    when "float16"
      ffi(:ngt_set_property_object_type_float16, property, error)
    when "integer"
      ffi(:ngt_set_property_object_type_integer, property, error)
    else
      raise ArgumentError, "Unknown object type: #{object_type}"
    end

    case distance_type.to_s.downcase
    when "l1"
      ffi(:ngt_set_property_distance_type_l1, property, error)
    when "l2"
      ffi(:ngt_set_property_distance_type_l2, property, error)
    when "angle"
      ffi(:ngt_set_property_distance_type_angle, property, error)
    when "hamming"
      ffi(:ngt_set_property_distance_type_hamming, property, error)
    when "jaccard"
      ffi(:ngt_set_property_distance_type_jaccard, property, error)
    when "cosine"
      ffi(:ngt_set_property_distance_type_cosine, property, error)
    when "normalized_angle"
      ffi(:ngt_set_property_distance_type_normalized_angle, property, error)
    when "normalized_cosine"
      ffi(:ngt_set_property_distance_type_normalized_cosine, property, error)
    else
      raise ArgumentError, "Unknown distance type: #{distance_type}"
    end

    index =
      if path
        ffi(:ngt_create_graph_and_tree, path, property, error)
      else
        ffi(:ngt_create_graph_and_tree_in_memory, property, error)
      end
  end

  FFI.add_finalizer(index, :ngt_close_index)

  super(index, path)
ensure
  FFI.ngt_destroy_error_object(error) if error
  FFI.ngt_destroy_property(property) if property
end

Instance Method Details

#batch_insert(objects, num_threads: 8) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/ngt/index.rb', line 53

def batch_insert(objects, num_threads: 8)
  if narray?(objects)
    check_dimensions(objects.shape[1])

    objects = objects.cast_to(Numo::SFloat) unless objects.is_a?(Numo::SFloat)
    count = objects.shape[0]
    obj = ::FFI::MemoryPointer.new(:char, objects.byte_size)
    obj.write_bytes(objects.to_binary)
  else
    objects = objects.to_a
    objects.each do |object|
      check_dimensions(object.size)
    end
    count = objects.size
    flat_objects = objects.flatten
    obj = ::FFI::MemoryPointer.new(:float, flat_objects.size)
    obj.write_array_of_float(flat_objects)
  end

  ids = ::FFI::MemoryPointer.new(:uint32, count)
  ffi(:ngt_batch_insert_index, @index, obj, count, ids)

  build_index(num_threads: num_threads)

  ids.read_array_of_uint32(count)
end

#build_index(num_threads: 8) ⇒ Object 



80
81
82
 
# File 'lib/ngt/index.rb', line 80

def build_index(num_threads: 8)
  ffi(:ngt_create_index, @index, num_threads)
end

#close ⇒ Object 



124
125
126
 
# File 'lib/ngt/index.rb', line 124

def close
  FFI.ngt_close_index(@index)
end

#dimensions ⇒ Object 



19
20
21
 
# File 'lib/ngt/index.rb', line 19

def dimensions
  @dimensions ||= ffi(:ngt_get_property_dimension, @property)
end

#distance_type ⇒ Object 



23
24
25
 
# File 'lib/ngt/index.rb', line 23

def distance_type
  @distance_type ||= ffi(:ngt_get_property_distance_type, @property)
end

#edge_size_for_creation ⇒ Object 



27
28
29
 
# File 'lib/ngt/index.rb', line 27

def edge_size_for_creation
  @edge_size_for_creation ||= ffi(:ngt_get_property_edge_size_for_creation, @property)
end

#edge_size_for_search ⇒ Object 



31
32
33
 
# File 'lib/ngt/index.rb', line 31

def edge_size_for_search
  @edge_size_for_search ||= ffi(:ngt_get_property_edge_size_for_search, @property)
end

#insert(object) ⇒ Object 



48
49
50
51
 
# File 'lib/ngt/index.rb', line 48

def insert(object)
  object = object.to_a
  ffi(:ngt_insert_index, @index, c_object(object), object.size)
end

#object(id) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/ngt/index.rb', line 84

def object(id)
  if object_type == :float
    res = ffi(:ngt_get_object_as_float, object_space, id)
    res.read_array_of_float(dimensions)
  elsif object_type == :integer
    res = ffi(:ngt_get_object_as_integer, object_space, id)
    res.read_array_of_uint8(dimensions)
  else
    raise Error, "Method not supported for this object type"
  end
end

#object_type ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/ngt/index.rb', line 35

def object_type
  @object_type ||= begin
    object_type = ffi(:ngt_get_property_object_type, @property)
    if FFI.ngt_is_property_object_type_float(object_type)
      :float
    elsif FFI.ngt_is_property_object_type_float16(object_type)
      :float16
    else
      :integer
    end
  end
end

#remove(id) ⇒ Object 



96
97
98
 
# File 'lib/ngt/index.rb', line 96

def remove(id)
  ffi(:ngt_remove_index, @index, id)
end

#save(path = nil) ⇒ Object 



119
120
121
122
 
# File 'lib/ngt/index.rb', line 119

def save(path = nil)
  @path = path || @path || Dir.mktmpdir
  ffi(:ngt_save_index, @index, @path)
end

#search(query, size: 20, epsilon: 0.1, radius: nil) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/ngt/index.rb', line 100

def search(query, size: 20, epsilon: 0.1, radius: nil)
  radius ||= -1.0
  results = ffi(:ngt_create_empty_results)
  query = query.to_a
  ffi(:ngt_search_index, @index, c_object(query), query.size, size, epsilon, radius, results)
  result_size = ffi(:ngt_get_result_size, results)
  ret = []
  result_size.times do |i|
    res = ffi(:ngt_get_result, results, i)
    ret << {
      id: res[:id],
      distance: res[:distance]
    }
  end
  ret
ensure
  FFI.ngt_destroy_results(results) if results
end