Class: Vector

Inherits:
Object show all
Defined in:
lib/classifier/extensions/vector.rb,
sig/vendor/matrix.rbs

Overview

Type stubs for matrix gem Using untyped elements since our usage is primarily with Floats/Numerics

Constant Summary collapse

EPSILON =

Returns:

  • (Float) 
1e-10

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.[] ⇒ Vector

Parameters:

Returns:



6
 
# File 'sig/vendor/matrix.rbs', line 6

def self.[]: (*untyped) -> Vector

Instance Method Details

#* ⇒ Object

Parameters:

Returns:



14
 
# File 'sig/vendor/matrix.rbs', line 14

def *: (untyped) -> untyped

#- ⇒ Vector

Parameters:

Returns:



15
 
# File 'sig/vendor/matrix.rbs', line 15

def -: (Vector) -> Vector

#[] ⇒ Object

Parameters:

  • (Integer)

Returns:



8
 
# File 'sig/vendor/matrix.rbs', line 8

def []: (Integer) -> untyped

#collect {|arg0| ... } ⇒ Vector

Yields:

Yield Parameters:

Yield Returns:

Returns:



12
 
# File 'sig/vendor/matrix.rbs', line 12

def collect: () { (untyped) -> untyped } -> Vector

#each {|arg0| ... } ⇒ void

This method returns an undefined value.

Yields:

Yield Parameters:

Yield Returns:

  • (void) 


11
 
# File 'sig/vendor/matrix.rbs', line 11

def each: () { (untyped) -> void } -> void

#is_a? ⇒ Boolean

Parameters:

Returns:

  • (Boolean) 


16
 
# File 'sig/vendor/matrix.rbs', line 16

def is_a?: (untyped) -> bool

#magnitude ⇒ Float

Returns:

  • (Float) 


29
30
31
32
33
34
35
36
37
38
 
# File 'lib/classifier/extensions/vector.rb', line 29

def magnitude
  # Cache magnitude since Vector is immutable after creation
  @magnitude ||= begin
    sum_of_squares = 0.to_r
    size.times do |i|
      sum_of_squares += self[i]**2.to_r
    end
    Math.sqrt(sum_of_squares.to_f)
  end
end

#normalize ⇒ Vector

Returns:



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/classifier/extensions/vector.rb', line 40

def normalize
  magnitude_value = magnitude
  return Vector[*Array.new(size, 0.0)] if magnitude_value <= 0.0

  normalized_values = []
  size.times do |i|
    normalized_values << (self[i] / magnitude_value)
  end
  Vector[*normalized_values]
end

#size ⇒ Integer

Returns:

  • (Integer) 


7
 
# File 'sig/vendor/matrix.rbs', line 7

def size: () -> Integer

#to_a ⇒ Array[untyped]

Returns:



13
 
# File 'sig/vendor/matrix.rbs', line 13

def to_a: () -> Array[untyped]