Class Vector
In: lib/matrix.rb
Parent: Object

The Vector class represents a mathematical vector, which is useful in its own right, and also constitutes a row or column of a Matrix.

Method Catalogue

To create a Vector:

To access elements:

  • [](i)

To enumerate the elements:

  • each2(v)
  • collect2(v)

Vector arithmetic:

  • *(x) "is matrix or number"
  • +(v)
  • -(v)

Vector functions:

Conversion to other data types:

String representations:

Methods

*   +   -   ==   []   []   []=   clone   coerce   collect   collect2   compare_by   component   covector   each2   element   elements   elements_to_f   elements_to_i   elements_to_r   eqn?   hash   init_elements   inner_product   inspect   map   map2   new   r   set_component   set_element   size   to_a   to_s  

Included Modules

ExceptionForMatrix

Public Class methods

[](*array)

Creates a Vector from a list of elements. 

  Vector[7, 4, ...]
elements(array, copy = true)

Creates a vector from an Array. The optional second argument specifies whether the array itself or a copy is used internally.

new(method, array, copy)

For internal use.

Public Instance methods

*(x)

Multiplies the vector by x, where x is a number or another vector.

+(v)

Vector addition.

-(v)

Vector subtraction.

==(other)

Returns true iff the two vectors have the same elements in the same order.

[](i)

Returns element number i (starting at zero) of the vector.

clone()

Return a copy of the vector.

collect2(v) {|e1, e2| ...}

Collects (as in Enumerable#collect) over the elements of this vector and v in conjunction.

compare_by(elements)

For internal use.

component(i)

Alias for #[]

covector()

Creates a single-row matrix from this vector.

each2(v) {|e1, e2| ...}

Iterate over the elements of this vector and v in conjunction.

element(i)

Alias for #[]

eqn?(other)

Alias for #==

hash()

Return a hash-code for the vector.

inner_product(v)

Returns the inner product of this vector with the other. 

  Vector[4,7].inner_product Vector[10,1]  => 47
map(

Alias for collect

map2(v) {|e1, e2| ...}

Like Vector#collect2, but returns a Vector instead of an Array.

r()

Returns the modulus (Pythagorean distance) of the vector. 

  Vector[5,8,2].r => 9.643650761
set_component(i, v)

Alias for #[]=

set_element(i, v)

Alias for #[]=

size()

Returns the number of elements in the vector.

to_a()

Returns the elements of the vector in an array.

[Validate]

ruby-doc.org is hosted and maintained by James Britt and Happy Camper Studios, a Ruby application development company in Phoenix, Arizona. The site was created in 2002 as part of the Ruby Documentation Project to promote the Ruby language and to help other Ruby hackers.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.