base.rb 11 KB
Newer Older
Brice Videau's avatar
Brice Videau committed
1
require 'singleton'
Brice Videau's avatar
Brice Videau committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
module CCS
  extend FFI::Library

  if ENV["LIBCCONFIGSPACE_SO"]
    ffi_lib ENV["LIBCCONFIGSPACE_SO"]
  else
    ffi_lib "cconfigspace"
  end

  class Pointer < FFI::Pointer
    def initialize(*args)
      if args.length == 2 then
        super(CCS::find_type(args[0]), args[1])
      else
        super(*args)
      end
    end
  end

  class MemoryPointer < FFI::MemoryPointer
    def initialize(size, count = 1, clear = true)
      if size.is_a?(Symbol)
        size = CCS::find_type(size)
      end
      super(size, count, clear)
    end
  end

  typedef :double, :ccs_float_t
  typedef :int64, :ccs_int_t
  typedef :int32, :ccs_bool_t
  typedef :int32, :ccs_result_t
  typedef :uint32, :ccs_hash_t

  class MemoryPointer
    alias read_ccs_float_t  read_double
    alias read_array_of_ccs_float_t  read_array_of_double
Brice Videau's avatar
Brice Videau committed
39
    alias write_array_of_ccs_float_t  write_array_of_double
Brice Videau's avatar
Brice Videau committed
40 41
    alias read_ccs_int_t    read_int64
    alias read_array_of_ccs_int_t  read_array_of_int64
Brice Videau's avatar
Brice Videau committed
42
    alias write_array_of_ccs_int_t  write_array_of_int64
Brice Videau's avatar
Brice Videau committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
    alias read_ccs_bool_t   read_int32
    alias read_ccs_result_t read_int32
    alias read_ccs_hash_t   read_uint32
    if FFI.find_type(:size_t).size == 8
      alias read_size_t read_uint64
    else
      alias read_size_t read_uint32
    end
  end

  class Version < FFI::Struct
    layout :revision, :uint16,
           :patch,    :uint16,
           :minor,    :uint16,
           :major,    :uint16
  end
  typedef Version.by_value, :ccs_version_t

  TRUE = 1
  FALSE = 0

  typedef :pointer, :ccs_rng_t
  typedef :pointer, :ccs_distribution_t
  typedef :pointer, :ccs_hyperparameter_t
  typedef :pointer, :ccs_expression_t
  typedef :pointer, :ccs_context_t
  typedef :pointer, :ccs_configuration_space_t
  typedef :pointer, :ccs_configuration_t
  typedef :pointer, :ccs_objective_space_t
  typedef :pointer, :ccs_evaluation_t
  typedef :pointer, :ccs_tuner_t
  typedef :pointer, :ccs_object_t
Brice Videau's avatar
Brice Videau committed
75 76 77 78 79 80 81 82 83 84 85 86 87
  class MemoryPointer
    alias read_ccs_rng_t read_pointer
    alias read_ccs_distribution_t read_pointer
    alias read_ccs_hyperparameter_t read_pointer
    alias read_ccs_expression_t read_pointer
    alias read_ccs_context_t read_pointer
    alias read_ccs_configuration_space_t read_pointer
    alias read_ccs_configuration_t read_pointer
    alias read_ccs_objective_space_t read_pointer
    alias read_ccs_evaluation_t read_pointer
    alias read_ccs_tuner_t read_pointer
    alias read_ccs_object_t read_pointer
  end
Brice Videau's avatar
Brice Videau committed
88 89 90 91 92 93 94 95 96 97 98 99

  Error = enum FFI::Type::INT32, :ccs_error_t, [
    :CCS_SUCCESS,
    :CCS_INVALID_OBJECT,
    :CCS_INVALID_VALUE,
    :CCS_INVALID_TYPE,
    :CCS_INVALID_SCALE,
    :CCS_INVALID_DISTRIBUTION,
    :CCS_INVALID_HYPERPARAMETER,
    :CCS_INVALID_CONFIGURATION,
    :CCS_INVALID_NAME,
    :CCS_INVALID_CONDITION,
Brice Videau's avatar
Brice Videau committed
100
    :CCS_INVALID_TUNER,
Brice Videau's avatar
Brice Videau committed
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 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 146
    :CCS_INVALID_GRAPH,
    :CCS_TYPE_NOT_COMPARABLE,
    :CCS_INVALID_BOUNDS,
    :CCS_OUT_OF_BOUNDS,
    :CCS_SAMPLING_UNSUCCESSFUL,
    :CCS_INACTIVE_HYPERPARAMETER,
    :CCS_OUT_OF_MEMORY,
    :CCS_UNSUPPORTED_OPERATION ]

  ObjectType = enum FFI::Type::INT32, :ccs_object_type_t, [
    :CCS_RNG,
    :CCS_DISTRIBUTION,
    :CCS_HYPERPARAMETER,
    :CCS_EXPRESSION,
    :CCS_CONFIGURATION_SPACE,
    :CCS_CONFIGURATION,
    :CCS_OBJECTIVE_SPACE,
    :CCS_EVALUATION,
    :CCS_TUNER ]
  class MemoryPointer
    def read_ccs_object_type_t
      ObjectType.from_native(read_int32, nil)
    end
  end

  DataType = enum FFI::Type::INT64, :ccs_data_type_t, [
    :CCS_NONE,
    :CCS_INTEGER,
    :CCS_FLOAT,
    :CCS_BOOLEAN,
    :CCS_STRING,
    :CCS_INACTIVE,
    :CCS_OBJECT ]

  NumericType = enum FFI::Type::INT64, :ccs_numeric_type_t, [
    :CCS_NUM_INTEGER, DataType.to_native(:CCS_INTEGER, nil),
    :CCS_NUM_FLOAT, DataType.to_native(:CCS_FLOAT, nil) ]
  class MemoryPointer
    def read_ccs_numeric_type_t
      NumericType.from_native(read_int32, nil)
    end
  end

  class Numeric < FFI::Union
    layout :f, :ccs_float_t,
           :i, :ccs_int_t
Brice Videau's avatar
Brice Videau committed
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
    def value(type)
      case type
      when :CCS_NUM_FLOAT
        self[:f]
      when :CCS_NUM_INTEGER
        self[:i]
      else
        raise StandardError, :CCS_INVALID_TYPE
      end
    end

    def self.from_value(v)
      case v
      when Float
        n = self::new
        n[:f] = v
        n
      when Integer
        n = self::new
        n[:i] = v
        n
      else
        raise StandardError, :CCS_INVALID_TYPE
      end
    end

    def value=(v)
      case v
      when Float
        self[:f] = v
      when Integer
        self[:i] = v
      else
        raise StandardError, :CCS_INVALID_TYPE
      end
    end
Brice Videau's avatar
Brice Videau committed
183 184 185 186 187 188
  end
  typedef Numeric.by_value, :ccs_numeric_t

  class Value < FFI::Union
    layout :f, :ccs_float_t,
           :i, :ccs_int_t,
Brice Videau's avatar
Brice Videau committed
189
           :s, :pointer,
Brice Videau's avatar
Brice Videau committed
190 191 192 193
           :o, :ccs_object_t
  end
  typedef Value.by_value, :ccs_value_t

Brice Videau's avatar
Brice Videau committed
194 195
  class InactiveClass
    include Singleton
Brice Videau's avatar
Brice Videau committed
196 197 198 199 200 201 202
    def to_s
      "inactive"
    end

    def inspect
      "inactive"
    end
Brice Videau's avatar
Brice Videau committed
203 204 205
  end
  Inactive = InactiveClass.instance

Brice Videau's avatar
Brice Videau committed
206 207 208 209
  class Datum < FFI::Struct
    layout :value, :ccs_value_t,
           :type, :ccs_data_type_t
  end
Brice Videau's avatar
Brice Videau committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
  class Datum
    NONE = self::new
    NONE[:type] = :CCS_NONE
    NONE[:value][:i] = 0
    TRUE = self::new
    TRUE[:type] = :CCS_BOOLEAN
    TRUE[:value][:i] = CCS::TRUE
    FALSE = self::new
    FALSE[:type] = :CCS_BOOLEAN
    FALSE[:value][:i] = CCS::FALSE
    INACTIVE = self::new
    INACTIVE[:type] = :CCS_INACTIVE
    INACTIVE[:value][:i] = 0
    def value
      case self[:type]
Brice Videau's avatar
Brice Videau committed
225
      when :CCS_NONE
Brice Videau's avatar
Brice Videau committed
226 227 228 229 230 231
        nil
      when :CCS_INTEGER
        self[:value][:i]
      when :CCS_FLOAT
        self[:value][:f]
      when :CCS_BOOLEAN
Brice Videau's avatar
Brice Videau committed
232
        self[:value][:i] == CCS::FALSE ? false : true
Brice Videau's avatar
Brice Videau committed
233 234 235 236 237 238
      when :CCS_STRING
        self[:value][:s].read_string
      when :CCS_INACTIVE
        Inactive
      when :CCS_OBJECT
        Object::from_handle(self[:value][:o])
Brice Videau's avatar
Brice Videau committed
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
      else
        raise StandardError, :CCS_INVALID_TYPE
      end
    end

    def value=(v, string_store: nil, object_store: nil)
      @string = nil if defined?(@string) && @string
      @object = nil if defined?(@object) && @object
      case v
      when nil
        self[:type] = :CCS_NONE
        self[:value][:i] = 0
      when true
        self[:type] = :CCS_BOOLEAN
        self[:value][:i] = 1
      when false
        self[:type] = :CCS_BOOLEAN
        self[:value][:i] = 0
      when Inactive
        self[:type] = :CCS_INACTIVE
        self[:value][:i] = 0
      when Float
        self[:type] = :CCS_FLOAT
        self[:value][:f] = v
      when Integer
        self[:type] = :CCS_INTEGER
        self[:value][:i] = v
      when String
        ptr = MemoryPointer::from_string(v)
        if string_store
          string_store.push ptr
        else
          @string = ptr
        end
        self[:type] = :CCS_STRING
        self[:value][:s] = ptr
      when Object
        if object_store
          object_store.push v
        else
          @object = v
        end
        self[:type] = :CCS_OBJECT
        self[:value][:o] = v.handle
      else
        raise StandardError, :CCS_INVALID_TYPE
Brice Videau's avatar
Brice Videau committed
285
      end
Brice Videau's avatar
Brice Videau committed
286
      v
Brice Videau's avatar
Brice Videau committed
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
    end

    def self.from_value(v)
      case v
      when nil
        NONE
      when true
        TRUE
      when false
        FALSE
      when Inactive
        INACTIVE
      when Float
        d = self::new
        d[:type] = :CCS_FLOAT
        d[:value][:f] = v
        d
      when Integer
        d = self::new
        d[:type] = :CCS_INTEGER
        d[:value][:i] = v
        d
      when String
        d = self::new
        ptr = MemoryPointer::from_string(v)
        d.instance_variable_set(:@string, ptr)
Brice Videau's avatar
Brice Videau committed
313 314
        d[:type] = :CCS_STRING
        d[:value][:s] = ptr
Brice Videau's avatar
Brice Videau committed
315 316 317 318 319 320 321 322
        d
      when Object
        d = self::new
        d[:type] = :CCS_OBJECT
        d[:value][:o] = v.handle
        d.instance_variable_set(:@object, v)
        d
      else
Brice Videau's avatar
Brice Videau committed
323
        raise StandardError, :CCS_INVALID_TYPE
Brice Videau's avatar
Brice Videau committed
324 325 326
      end
    end
  end
Brice Videau's avatar
Brice Videau committed
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
  typedef Datum.by_value, :ccs_datum_t

  attach_function :ccs_init, [], :ccs_result_t
  attach_function :ccs_get_version, [], :ccs_version_t
  attach_function :ccs_retain_object, [:ccs_object_t], :ccs_result_t
  attach_function :ccs_release_object, [:ccs_object_t], :ccs_result_t
  attach_function :ccs_object_get_type, [:ccs_object_t, :pointer], :ccs_result_t
  attach_function :ccs_object_get_refcount, [:ccs_object_t, :pointer], :ccs_result_t

  class << self
    alias version ccs_get_version
  end

  def self.error_check(result)
    if result < 0
      raise StandardError, Error.from_native(-result, nil)
    end
  end

  def self.init
    res = ccs_init
    error_check(res)
    self
  end

  class Object
    class Releaser
      def initialize(handle)
        @handle = handle
      end

      def call(id)
        CCS.ccs_release_object(@handle)
      end
    end
Brice Videau's avatar
Brice Videau committed
362

Brice Videau's avatar
Brice Videau committed
363 364 365 366 367 368 369 370 371 372 373 374
    def self.add_property(name, type, accessor, memoize: false)
      src = ""
      src << "def #{name}\n"
      src << "  @#{name} ||= begin\n" if memoize
      src << "  ptr = MemoryPointer::new(:#{type})\n"
      src << "  res = CCS.#{accessor}(@handle, ptr)\n"
      src << "  CCS.error_check(res)\n"
      src << "  ptr.read_#{type}\n"
      src << "  end\n" if memoize
      src << "end\n"
      class_eval src
    end
Brice Videau's avatar
Brice Videau committed
375

Brice Videau's avatar
Brice Videau committed
376 377 378 379 380 381 382 383 384 385 386 387 388
    def self.add_handle_property(name, type, accessor, memoize: false)
      src = ""
      src << "def #{name}\n"
      src << "  @#{name} ||= begin\n" if memoize
      src << "  ptr = MemoryPointer::new(:#{type})\n"
      src << "  res = CCS.#{accessor}(@handle, ptr)\n"
      src << "  CCS.error_check(res)\n"
      src << "  Object::from_handle(ptr.read_#{type})\n"
      src << "  end\n" if memoize
      src << "end\n"
      class_eval src
    end

Brice Videau's avatar
Brice Videau committed
389 390
    add_property :object_type, :ccs_object_type_t, :ccs_object_get_type, memoize: true
    add_property :refcount, :uint32, :ccs_object_get_refcount
Brice Videau's avatar
Brice Videau committed
391
    attr_reader :handle
Brice Videau's avatar
Brice Videau committed
392

Brice Videau's avatar
Brice Videau committed
393
    def initialize(handle, retain: false, auto_release: true)
Brice Videau's avatar
Brice Videau committed
394 395 396
      if !handle
        raise StandardError, :CCS_INVALID_OBJECT
      end
Brice Videau's avatar
Brice Videau committed
397 398 399 400 401
      @handle = handle
      if retain
        res = CCS.ccs_retain_object(handle)
        CCS.error_check(res)
      end
Brice Videau's avatar
Brice Videau committed
402
      ObjectSpace.define_finalizer(self, Releaser::new(handle)) if auto_release
Brice Videau's avatar
Brice Videau committed
403 404
    end

Brice Videau's avatar
Brice Videau committed
405
    def self.from_handle(handle)
Brice Videau's avatar
Brice Videau committed
406
      ptr = MemoryPointer::new(:ccs_object_type_t)
Brice Videau's avatar
Brice Videau committed
407
      res = CCS.ccs_object_get_type(handle, ptr)
Brice Videau's avatar
Brice Videau committed
408
      CCS.error_check(res)
Brice Videau's avatar
Brice Videau committed
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
      case ptr.read_ccs_object_type_t
      when :CCS_RNG
        CCS::Rng::from_handle(handle)
      when :CCS_DISTRIBUTION
        CCS::Distribution::from_handle(handle)
      when :CCS_HYPERPARAMETER
        CCS::Hyperparameter::from_handle(handle)
      when :CCS_EXPRESSION
        CCS::Expression::from_handle(handle)
      when :CCS_CONFIGURATION_SPACE
        CCS::ConfigurationSpace::from_handle(handle)
      when :CCS_CONFIGURATION
        CCS::Configuration::from_handle(handle)
      when :CCS_OBJECTIVE_SPACE
        CCS::ObjectiveSpace::from_handle(handle)
      when :CCS_EVALUATION
        CCS::Evaluation::from_handle(handle)
      when :CCS_TUNER
        CCS::Tuner::from_handle(handle)
      else
        raise StandardError, :CCS_INVALID_OBJECT
      end
Brice Videau's avatar
Brice Videau committed
431 432 433 434 435 436 437 438 439
    end

    def to_ptr
      @handle
    end

  end

end