Array Class Reference

#include <ql/Math/array.hpp>

List of all members.


Detailed Description

1-D array used in linear algebra.

This class implements the concept of vector as used in linear algebra. As such, it is not meant to be used as a container - std::vector should be used instead.


Public Types

typedef Realiterator
typedef const Realconst_iterator

Public Member Functions

typedef QL_REVERSE_ITERATOR (iterator, Real) reverse_iterator
typedef QL_REVERSE_ITERATOR (const_iterator, Real) const _reverse_iterator
Constructors, destructor, and assignment
 Array (Size size=0)
 creates the array with the given dimension

 Array (Size size, Real value)
 creates the array and fills it with value

 Array (Size size, Real value, Real increment)
 creates the array and fills it according to $ a_{0} = value, a_{i}=a_{i-1}+increment $

 Array (const Array &)
 Array (const Disposable< Array > &)
Arrayoperator= (const Array &)
Arrayoperator= (const Disposable< Array > &)
Vector algebra
v += x and similar operation involving a scalar value are shortcuts for $ \forall i : v_i = v_i + x $

v *= w and similar operation involving two vectors are shortcuts for $ \forall i : v_i = v_i \times w_i $

Precondition:
all arrays involved in an algebraic expression must have the same size.


const Arrayoperator+= (const Array &)
const Arrayoperator+= (Real)
const Arrayoperator-= (const Array &)
const Arrayoperator-= (Real)
const Arrayoperator *= (const Array &)
const Arrayoperator *= (Real)
const Arrayoperator/= (const Array &)
const Arrayoperator/= (Real)
Element access
Real operator[] (Size) const
 read-only

Realoperator[] (Size)
 read-write

Inspectors
Size size () const
 dimension of the array

Iterator access
const_iterator begin () const
iterator begin ()
const_iterator end () const
iterator end ()
const_reverse_iterator rbegin () const
reverse_iterator rbegin ()
const_reverse_iterator rend () const
reverse_iterator rend ()
Utilities
void swap (Array &)

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &, const Array &)
Real DotProduct (const Array &, const Array &)
const Disposable< Arrayoperator+ (const Array &v)
const Disposable< Arrayoperator- (const Array &v)
const Disposable< Arrayoperator+ (const Array &, const Array &)
const Disposable< Arrayoperator+ (const Array &, Real)
const Disposable< Arrayoperator+ (Real, const Array &)
const Disposable< Arrayoperator- (const Array &, const Array &)
const Disposable< Arrayoperator- (const Array &, Real)
const Disposable< Arrayoperator- (Real, const Array &)
const Disposable< Arrayoperator * (const Array &, const Array &)
const Disposable< Arrayoperator * (const Array &, Real)
const Disposable< Arrayoperator * (Real, const Array &)
const Disposable< Arrayoperator/ (const Array &, const Array &)
const Disposable< Arrayoperator/ (const Array &, Real)
const Disposable< Arrayoperator/ (Real, const Array &)
const Disposable< ArrayAbs (const Array &)
const Disposable< ArraySqrt (const Array &)
const Disposable< ArrayLog (const Array &)
const Disposable< ArrayExp (const Array &)


QuantLib.org
QuantLib
Hosted by
SourceForge.net Logo
Documentation generated by
doxygen