# Vector

[2002-04-03] by すす

数 Numeric を要素とするベクトルを扱うクラス。

## 使い方　Usage

Vectorクラスを使うためには、require 'matrix'する必要がある。

    require 'matrix'

## インスタンス生成 Instance Creation

`Vector.[a]`

  配列aを要素とするベクトルを生成する。

`Vector.elements(a, copy = true)`

  配列aを要素とするベクトルを生成する。 ただし、オプション引数copyが偽(false)ならば、複製を行わない。

## 読み出し書き込み Accessing

`Vector#[i]`

  i番目の要素を返す。インデックスは0から開始する。

`Vector#size`

  ベクトルの大きさを返す。

`Vector#[i] = x`

  i番目の要素をxに変更する。

このメソッドは、matrix.rbに定義されていない。 以下に、その定義と使用例を示す。

    require 'matrix'

    class Vector
      def []=(i,x)
        @elements[i]=x
      end
    end

    v=Vector[1,2,3]
    v[2]=-1
    p v #=> Vector[1,2,-1]

## 演算 Arithmatics

`Vector#* a`

  数aを乗じたベクトルを返す。

`Vector#* m`

  列ベクトル(行列)に変換して(実際にはMatrix#column_vector(self)を適用)から、行列mを右から乗じた行列(Matrixクラス)を返す。

`Vector#+ v`

  ベクトルvを加えたベクトルを返す。

`Vector#- v`

  ベクトルvを減じたベクトルを返す。

## ベクトルに対する関数 Vector Functions

`Vector#inner_product(v)`

  ベクトルvとの内積を返す。

`Vector#r`

  ベクトルの絶対値を返す。 ベクトルの絶対値は、各要素の２乗の和の平方根を取ったものである。

## イテレータ Iterators

`Vector#collect {|x| ... }`
`Vector#map {|x| ... }`

  ベクトルの各要素に対してブロックを評価した結果を、要素として持つベクトルを生成する。

`Vector#each2(v) {|x,y| ... }`

  ベクトルの各要素と、それに対応するインデックスを持つ引数vの要素との組に対して(2引数の)ブロックを繰返し評価する。`v'はsizeメソッドと[]メソッドを持つオブジェクトである。*1

`Vector#collect2(v) {|x,y| ... }`

  ベクトルの各要素と、それに対応するインデックスを持つ引数vの要素との組に対して(2引数の)ブロックを評価し、その結果を要素として持つ配列を生成する。

`Vector#map2(v) {|x,y| ... }`

  ベクトルの各要素と、それに対応するインデックスを持つ引数(配列)の要素との組に対して(2引数の)ブロックを評価した結果を、要素として持つベクトルを返す。

次の例は、二つのベクトルの要素毎の積をとる。

    require 'matrix'

    v = Vector[2,3,5]
    w = Vector[7,9,11]
    z1 = v.collect2(w){|x,y| x*y }
    z2 = v.map2(w) {|x,y| x*y }

    p z1 #=> [14, 27, 55]
    p z2 #=> Vector[14, 27, 55]

## 型変換 Converting

`Vector#covector`

  列ベクトル(行列)、すなわち、(n,1)型の行列に変換する。 実際にはMatrix#row_vector(self)を適用する。

`Vector#to_a`

  配列(Array)に変換する

`Vector#to_f`

  各要素を浮動小数点数(Float)に変換する

`Vector#to_i`

  各要素を整数(Integer)に変換する

`Vector#to_r`

  各要素を有理数(Rational)に変換する

## Complexクラスとの併用 Working with Complex class

require 'complex'することによって、 Vectorオブジェクトの要素はComplexクラスに拡張される。 多くのメソッドは、この拡張されたVectorクラスでも、期待通りに動作する。

次の例は、各要素を共役複素数に置換するメソッド(Vector#conjugate)である。

    require 'matrix'
    require 'complex'

    class Vector
      def conjugate
        collect{|e| e.conjugate }
      end
    end

    v1 = Vector[Complex(1,1),Complex(2,2),Complex(3,3)]
    v2 = v1.conjugate
    p v2 #=> Vector[Complex(1,-1),Complex(2,-2),Complex(3,-3)]
    v3 = v1+v2
    p v3 #=> Vector[Complex(1,0),Complex(2,0),Complex(3,0)]

しかし、Complex要素に拡張されたVectorクラスで、 期待通りに動作しないメソッドもある。 例えば、ベクトルの絶対値を求めるVector#rメソッドは、 各要素の2乗和の平方根Math#sqrtを求めるが、 このとき例外を発生させる可能性がある。

複素数を要素とするベクトルの絶対値を求めるためには、 各要素の絶対値の2乗和をとらなくてはならない(次の例 Vector#absメソッド）。

    require 'matrix'
    require 'complex'

    class Vector
      def abs
        r=0
        @elements.each{|e| r += e.abs2 }
        Math.sqrt(r)
      end
    end

    v = Vector[Complex(1,1),Complex(2,2),Complex(3,3)}
    p v.abs #=> 5.291502622 # Math.sqrt(28)
    p v.r   #=> 'sqrt': undefined method `Rational'

## ChangeLog

- [2002-04-03] by すす
  - 使い方の節を追加
  - Working with Complex classの節を追加
  - []=メソッドを追加
  - イテレータ関係を同じ節にまとめた collect, map, each2, collect2, map2
  - 誤りを訂正し、説明を直した。 とくにeach2, collect2, map2
  - 他クラスへのリンクを追加 Numeric, Matrix
- [2002-04-02] 初版 by すす

*1 sizeメソッドと[]メソッドを持つことをもってArrayクラスの定義としてよいのでしょうか? 単純に配列クラスと書けるとうれしいです。

links: [Array] [Complex] [Float] [Integer] [Math] [Matrix] [Numeric] [Rational] [Vector]
reverse links: [Complex] [Matrix] [matrix.rb]