Logo Search packages:      
Sourcecode: quantlib version File versions  Download package

QuantLib::Array Class Reference

1-D array used in linear algebra. More...

#include <array.hpp>

List of all members.

Public Types

typedef const Realconst_iterator
typedef
boost::reverse_iterator
< const_iterator > 
const_reverse_iterator
typedef Realiterator
typedef
boost::reverse_iterator
< iterator > 
reverse_iterator
typedef Size size_type
typedef Real value_type

Public Member Functions

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 > &)
template<class ForwardIterator >
 Array (ForwardIterator begin, ForwardIterator end)
 creates the array from an iterable sequence
Arrayoperator= (const Array &)
Arrayoperator= (const Disposable< Array > &)
bool operator== (const Array &) const
bool operator!= (const Array &) const
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
Real at (Size) const
Real front () const
Real back () const
Realoperator[] (Size)
 read-write
Realat (Size)
Realfront ()
Realback ()
Inspectors
Size size () const
 dimension of the array
bool empty () const
 whether the array is empty
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 &)

Private Attributes

boost::scoped_array< Realdata_
Size n_

Related Functions

(Note that these are not member functions.)

const Disposable< ArrayAbs (const Array &)
Real DotProduct (const Array &, const Array &)
const Disposable< ArrayExp (const Array &)
const Disposable< ArrayLog (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 &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 &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 &)
std::ostream & operator<< (std::ostream &, const Array &)
const Disposable< ArraySqrt (const Array &)
void swap (Array &, Array &)

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.

Test:
construction of arrays is checked in a number of cases

Definition at line 51 of file array.hpp.


The documentation for this class was generated from the following file:

Generated by  Doxygen 1.6.0   Back to index