# QuantLib_Array man page

Array — 1-D array used in linear algebra.

## Synopsis

`#include <ql/math/array.hpp>`

### Public Types

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

### 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
Array & operator= (const Array &)
Array & operator= (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 \$ rall i : v_i = v_i + x \$

`v *= w` and similar operation involving two vectors are shortcuts for \$ rall i : v_i = v_i imes w_i \$

Precondition:

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

const Array & operator+= (const Array &)
const Array & operator+= (Real)
const Array & operator-= (const Array &)
const Array & operator-= (Real)
const Array & operator*= (const Array &)
const Array & operator*= (Real)
const Array & operator/= (const Array &)
const Array & operator/= (Real)

Element access

Real operator[] (Size) const
Real at (Size) const
Real front () const
Real back () const
Real & operator[] (Size)
Real & at (Size)
Real & front ()
Real & back ()

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 &)

## 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.

Tests

construction of arrays is checked in a number of cases

## Author

Generated automatically by Doxygen for QuantLib from the source code.

## Referenced By

The man pages Array(3), at(3), back(3), begin(3), const_iterator(3), const_reverse_iterator(3), empty(3), front(3), iterator(3), operator-=(3), operator=(3), operator[](3), ql-end(3), rbegin(3), rend(3), reverse_iterator(3), size(3), size_type(3) and value_type(3) are aliases of QuantLib_Array(3).

Mon Apr 30 2018 Version 1.12.1 QuantLib