=begin
= GSL::Vector::Complex

== Class methods
--- GSL::Vector::Complex.alloc(size)
--- GSL::Vector::Complex.alloc(re, im)
--- GSL::Vector::Complex.alloc(z0, z1, z2, ...)
--- GSL::Vector::Complex.alloc()
--- GSL::Vector::Complex[...]
    Constructors.

    (1) With two (real) vectors:
          irb(main):006:0> re = Vector[0..3]
          irb(main):007:0> im = Vector[5..8]
          irb(main):008:0> z = Vector::Complex[re, im]
          [ [0.000e+00 5.000e+00] [1.000e+00 6.000e+00] [2.000e+00 7.000e+00] [3.000e+00 8.000e+00] ]

    (2) With arrays
          irb(main):009:0> z = Vector::Complex.alloc([0, 1], [2, 5], [-3, 4])
          [ [0.000e+00 1.000e+00] [2.000e+00 5.000e+00] [-3.000e+00 4.000e+00] ]

--- GSL::Vector::Complex.calloc(n)
    Creates a complex vector of length ((|n|)) and initializes all 
    the elements of the vector to zero.

== Instance methods
=== Accessing vector elements
--- GSL::Vector::Complex#get(...)
--- GSL::Vector::Complex#[...]
    Returns the ((|i|))-th element (complex) of a complex vector ((|self|)). 

    Example:
      irb(main):010:0> z
      [ [0.000e+00 1.000e+00] [2.000e+00 5.000e+00] [-3.000e+00 4.000e+00] ]
      => #<GSL::Vector::Complex:0x6c5b9c>
      irb(main):011:0> z[1]
      => GSL::Complex
      [ 2.000000 5.000000 ]
      irb(main):012:0> z[-1]
      => GSL::Complex
      [ -3.000000 4.000000 ]
      irb(main):013:0> z[0, 2]
      [ [0.000e+00 1.000e+00] [-3.000e+00 4.000e+00] ]
      => #<GSL::Vector::Complex:0x6bfbac>

--- GSL::Vector::Complex#set(i, z)
--- GSL::Vector::Complex#[]=(i, z)
    Sets the value of the ((|i|))-th element of a complex vector ((|self|)) to ((|z|)).

=== Initializing vector elements
--- GSL::Vector::Complex#set_all(z)
    Sets all the elements of the complex vector ((|self|)) to the complex ((|z|)).
--- GSL::Vector::Complex#set_zero
    Sets all the elements of the vector ((|self|)) to zero.

=== Vector properties
--- GSL::Vector::Complex#size
--- GSL::Vector::Complex#stride

=== Iterators
--- GSL::Vector::Complex#each
--- GSL::Vector::Complex#each_index

=== Reading and writing vectors
--- GSL::Vector::Complex#fwite(io)
--- GSL::Vector::Complex#fread(io)
--- GSL::Vector::Complex#fprintf(io, format)
--- GSL::Vector::Complex#fscanf(io)

=== Functions
--- GSL::Vector::Complex#arg
--- GSL::Vector::Complex#phase
    Calculates the squared argument of each of the complex elements of the vector ((|self|)), and returns a real vector.

--- GSL::Vector::Complex#abs2
    Calculates the squared magnitude of the complex elements of the vector ((|self|)) and returns a real vector.

--- GSL::Vector::Complex#abs
--- GSL::Vector::Complex#amp
    Calculates the magnitude of the complex elements of the vector ((|self|)) and returns a real vector.

--- GSL::Vector::Complex#logabs
    Calculates the natural logarithm of the magnitude of the complex elements of the vector ((|self|)) and returns a real vector.

--- GSL::Vector::Complex#sqrt
    Calculates the square root of the complex elements of the vector ((|self|)) and returns a new complex vector.

--- GSL::Vector::Complex#exp
--- GSL::Vector::Complex#pow(a)
--- GSL::Vector::Complex#log
--- GSL::Vector::Complex#log10
--- GSL::Vector::Complex#log_b(base)
--- GSL::Vector::Complex#sin
--- GSL::Vector::Complex#cos
--- GSL::Vector::Complex#tan
--- GSL::Vector::Complex#sec
--- GSL::Vector::Complex#csc
--- GSL::Vector::Complex#cot
--- GSL::Vector::Complex#arcsin
--- GSL::Vector::Complex#arccos
--- GSL::Vector::Complex#arctan
--- GSL::Vector::Complex#arcsec
--- GSL::Vector::Complex#arccsc
--- GSL::Vector::Complex#arccot
--- GSL::Vector::Complex#sinh
--- GSL::Vector::Complex#cosh
--- GSL::Vector::Complex#tanh
--- GSL::Vector::Complex#sech
--- GSL::Vector::Complex#csch
--- GSL::Vector::Complex#coth
--- GSL::Vector::Complex#arcsinh
--- GSL::Vector::Complex#arccosh
--- GSL::Vector::Complex#arctanh
--- GSL::Vector::Complex#arcsech
--- GSL::Vector::Complex#arccsch
--- GSL::Vector::Complex#arccoth

== Data Conversions
--- GSL::Vector#to_complex
--- GSL::Vector#to_complex2
    Create a complex vector from a real vector.

      irb(main):002:0> v = Vector[1..4]
      => GSL::Vector
      [ 1.000e+00 2.000e+00 3.000e+00 4.000e+00 ]
      irb(main):003:0> v.to_complex
      [ [1.000e+00 0.000e+00] [2.000e+00 0.000e+00] [3.000e+00 0.000e+00] [4.000e+00 0.000e+00] ]
      => #<GSL::Vector::Complex:0x6d7d24>
      irb(main):004:0> v.to_complex2
      [ [1.000e+00 2.000e+00] [3.000e+00 4.000e+00] ]
      => #<GSL::Vector::Complex:0x6d6424>

((<Reference index|URL:ref.html>))
((<top|URL:index.html>))

=end