# Banded Matrix

#### Description

The templated class `banded_matrix<T, F, A>` is the base container adaptor for banded matrices. For a (m x n)-dimensional banded matrix with l lower and u upper diagonals and 0 <= i < m, 0 <= j < n holds bi, j = 0, if i > j + l or i < j - u. The storage of banded matrices is packed.

#### Example

    int main () {

        using namespace boost::numeric::ublas;

        banded_matrix<double> m (3, 3, 1, 1);

        for (int i = 0; i < m.size1 (); ++ i)

            for (int j = std::max (i - 1, 0); j < std::min (i + 2, m.size2 ()); ++ j)

                m (i, j) = 3 * i + j;

        std::cout << m << std::endl;

    }

#### Definition

Defined in the header banded.hpp.

#### Template parameters

Parameter | Description | Default
--- | --- | ---
`T` | The type of object stored in the matrix. |
`F` | Functor describing the storage organization. [1] | `row_major`
`A` | The type of the adapted array. [2] | `unbounded_array<T>`

#### Model of

Matrix.

#### Type requirements

None, except for those imposed by the requirements of Matrix.

#### Public base classes

`matrix_expression<banded_matrix<T, F, A> >`

#### Members

Member | Description
--- | ---
`banded_matrix ()` | Allocates an uninitialized `banded_matrix` that holds zero rows of zero elements.
`banded_matrix (size_type size1, size_type size2, size_type lower = 0, size_type upper = 0)` | Allocates an uninitialized `banded_matrix` that holds `(lower + 1 + upper)` diagonals around the main diagonal of a matrix with `size1` rows of `size2` elements.
`banded_matrix (const banded_matrix &m)` | The copy constructor.
`template<class AE> banded_matrix (const matrix_expression<AE> &ae)` | The extended copy constructor.
`void resize (size_type size1, size_type size2, size_type lower = 0, size_type upper = 0)` | Reallocates a `banded_matrix` to hold `(lower + 1 + upper)` diagonals around the main diagonal of a matrix with `size1` rows of `size2` elements. The content of the `banded_matrix` is not preserved.
`size_type size1 () const` | Returns the number of rows.
`size_type size2 () const` | Returns the number of columns.
`size_type lower () const` | Returns the number of diagonals below the main diagonal.
`size_type upper () const` | Returns the number of diagonals above the main diagonal.
`const_reference operator () (size_type i, size_type j) const` | Returns a `const` reference of the `j`-th element in the `i`-th row.
`reference operator () (size_type i, size_type j)` | Returns a reference of the `j`-th element in the `i`-th row.
`banded_matrix &operator = (const banded_matrix &m)` | The assignment operator.
`banded_matrix &assign_temporary (banded_matrix &m)` | Assigns a temporary. May change the banded matrix `m`.
`template<class AE> banded_matrix &operator = (const matrix_expression<AE> &ae)` | The extended assignment operator.
`template<class AE> banded_matrix &assign (const matrix_expression<AE> &ae)` | Assigns a matrix expression to the banded matrix. Left and right hand side of the assignment should be independent.
`template<class AE> banded_matrix &operator += (const matrix_expression<AE> &ae)` | A computed assignment operator. Adds the matrix expression to the banded matrix.
`template<class AE> banded_matrix &plus_assign (const matrix_expression<AE> &ae)` | Adds a matrix expression to the banded matrix. Left and right hand side of the assignment should be independent.
`template<class AE> banded_matrix &operator -= (const matrix_expression<AE> &ae)` | A computed assignment operator. Subtracts the matrix expression from the banded matrix.
`template<class AE> banded_matrix &minus_assign (const matrix_expression<AE> &ae)` | Subtracts a matrix expression from the banded matrix. Left and right hand side of the assignment should be independent.
`template<class AT> banded_matrix &operator *= (const AT &at)` | A computed assignment operator. Multiplies the banded matrix with a scalar.
`template<class AT> banded_matrix &operator /= (const AT &at)` | A computed assignment operator. Divides the banded matrix through a scalar.
`void swap (banded_matrix &m)` | Swaps the contents of the banded matrices.
`void insert (size_type i, size_type j, const_reference t)` | Inserts the value `t` at the `j`-th element of the `i`-th row.
`void erase (size_type i, size_type j)` | Erases the value at the `j`-th elemenst of the `i`-th row.
`void clear ()` | Clears the matrix.
`const_iterator1 begin1 () const` | Returns a `const_iterator1` pointing to the beginning of the `banded_matrix`.
`const_iterator1 end1 () const` | Returns a `const_iterator1` pointing to the end of the `banded_matrix`.
`iterator1 begin1 ()` | Returns a `iterator1` pointing to the beginning of the `banded_matrix`.
`iterator1 end1 ()` | Returns a `iterator1` pointing to the end of the `banded_matrix`.
`const_iterator2 begin2 () const` | Returns a `const_iterator2` pointing to the beginning of the `banded_matrix`.
`const_iterator2 end2 () const` | Returns a `const_iterator2` pointing to the end of the `banded_matrix`.
`iterator2 begin2 ()` | Returns a `iterator2` pointing to the beginning of the `banded_matrix`.
`iterator2 end2 ()` | Returns a `iterator2` pointing to the end of the `banded_matrix`.
`const_reverse_iterator1 rbegin1 () const` | Returns a `const_reverse_iterator1` pointing to the beginning of the reversed `banded_matrix`.
`const_reverse_iterator1 rend1 () const` | Returns a `const_reverse_iterator1` pointing to the end of the reversed `banded_matrix`.
`reverse_iterator1 rbegin1 ()` | Returns a `reverse_iterator1` pointing to the beginning of the reversed `banded_matrix`.
`reverse_iterator1 rend1 ()` | Returns a `reverse_iterator1` pointing to the end of the reversed `banded_matrix`.
`const_reverse_iterator2 rbegin2 () const` | Returns a `const_reverse_iterator2` pointing to the beginning of the reversed `banded_matrix`.
`const_reverse_iterator2 rend2 () const` | Returns a `const_reverse_iterator2` pointing to the end of the reversed `banded_matrix`.
`reverse_iterator2 rbegin2 ()` | Returns a `reverse_iterator2` pointing to the beginning of the reversed `banded_matrix`.
`reverse_iterator2 rend2 ()` | Returns a `reverse_iterator2` pointing to the end of the reversed `banded_matrix`.

#### Notes

[1] Supported parameters for the storage organization are `row_major` and `column_major`.

[2] Supported parameters for the adapted array are `unbounded_array<T>`, `bounded_array<T>` and `std::vector<T>`.

#### Interface

        // Array based banded matrix class

        template<class T, class F, class A>

        class banded_matrix:

            public matrix_expression<banded_matrix<T, F, A> > {

        public:

            typedef std::size_t size_type;

            typedef std::ptrdiff_t difference_type;

            typedef T value_type;

            typedef const T &const_reference;

            typedef T &reference;

            typedef const T *const_pointer;

            typedef T *pointer;

            typedef F functor_type;

            typedef A array_type;

            typedef const A const_array_type;

            typedef const banded_matrix<T, F, A> const_self_type;

            typedef banded_matrix<T, F, A> self_type;

            typedef const matrix_const_reference<const_self_type> const_closure_type;

            typedef matrix_reference<self_type> closure_type;

            typedef packed_tag storage_category;

            typedef typename F::orientation_category orientation_category;

            // Construction and destruction

            banded_matrix ();

            banded_matrix (size_type size1, size_type size2, size_type lower = 0, size_type upper = 0);

            banded_matrix (const banded_matrix &m);

            template<class AE>

            banded_matrix (const matrix_expression<AE> &ae, size_type lower = 0, size_type upper = 0);

            // Accessors

            size_type size1 () const;

            size_type size2 () const;

            size_type lower () const;

            size_type upper () const;

            const_array_type &data () const;

            array_type &data ();

            // Resizing

            void resize (size_type size1, size_type size2, size_type lower = 0, size_type upper = 0);

            // Element access

            const_reference operator () (size_type i, size_type j) const;

            reference operator () (size_type i, size_type j);

            // Assignment

            banded_matrix &operator = (const banded_matrix &m);

            banded_matrix &assign_temporary (banded_matrix &m);

            template<class AE>

            banded_matrix &operator = (const matrix_expression<AE> &ae);

            template<class AE>

            banded_matrix &reset (const matrix_expression<AE> &ae);

            template<class AE>

            banded_matrix &assign (const matrix_expression<AE> &ae);

            template<class AE>

            banded_matrix& operator += (const matrix_expression<AE> &ae);

            template<class AE>

            banded_matrix &plus_assign (const matrix_expression<AE> &ae);

            template<class AE>

            banded_matrix& operator -= (const matrix_expression<AE> &ae);

            template<class AE>

            banded_matrix &minus_assign (const matrix_expression<AE> &ae);

            template<class AT>

            banded_matrix& operator *= (const AT &at);

            template<class AT>

            banded_matrix& operator /= (const AT &at);

            // Swapping

            void swap (banded_matrix &m);

            friend void swap (banded_matrix &m1, banded_matrix &m2);

            // Element insertion and erasure

            void insert (size_type i, size_type j, const_reference t);

            void erase (size_type i, size_type j);

            void clear ();

            class const_iterator1;

            class iterator1;

            class const_iterator2;

            class iterator2;

            typedef reverse_iterator_base1<const_iterator1> const_reverse_iterator1;

            typedef reverse_iterator_base1<iterator1> reverse_iterator1;

            typedef reverse_iterator_base2<const_iterator2> const_reverse_iterator2;

            typedef reverse_iterator_base2<iterator2> reverse_iterator2;

            // Element lookup

            const_iterator1 find1 (int rank, size_type i, size_type j) const;

            iterator1 find1 (int rank, size_type i, size_type j);

            const_iterator2 find2 (int rank, size_type i, size_type j) const;

            iterator2 find2 (int rank, size_type i, size_type j);

            const_iterator1 find_first1 (int rank, size_type i, size_type j) const;

            iterator1 find_first1 (int rank, size_type i, size_type j);

            const_iterator1 find_last1 (int rank, size_type i, size_type j) const;

            iterator1 find_last1 (int rank, size_type i, size_type j);

            const_iterator2 find_first2 (int rank, size_type i, size_type j) const;

            iterator2 find_first2 (int rank, size_type i, size_type j);

            const_iterator2 find_last2 (int rank, size_type i, size_type j) const;

            iterator2 find_last2 (int rank, size_type i, size_type j);

            // Iterators simply are indices.

            class const_iterator1:

                public container_const_reference<banded_matrix>,

                public random_access_iterator_base<const_iterator1, value_type> {

            public:

                typedef packed_random_access_iterator_tag iterator_category;

                typedef typename banded_matrix::difference_type difference_type;

                typedef typename banded_matrix::value_type value_type;

                typedef typename banded_matrix::const_reference reference;

                typedef typename banded_matrix::const_pointer pointer;

                typedef const_iterator2 dual_iterator_type;

                typedef const_reverse_iterator2 dual_reverse_iterator_type;

                // Construction and destruction

                const_iterator1 ();

                const_iterator1 (const banded_matrix &m, size_type it1, size_type it2);

                const_iterator1 (const iterator1 &it);

                // Arithmetic

                const_iterator1 &operator ++ ();

                const_iterator1 &operator -- ();

                const_iterator1 &operator += (difference_type n);

                const_iterator1 &operator -= (difference_type n);

                difference_type operator - (const const_iterator1 &it) const;

                // Dereference

                reference operator * () const;

                const_iterator2 begin () const;

                const_iterator2 end () const;

                const_reverse_iterator2 rbegin () const;

                const_reverse_iterator2 rend () const;

                // Indices

                size_type index1 () const;

                size_type index2 () const;

                // Assignment

                const_iterator1 &operator = (const const_iterator1 &it);

                // Comparison

                bool operator == (const const_iterator1 &it) const;

                bool operator < (const const_iterator1 &it) const;

            };

            const_iterator1 begin1 () const;

            const_iterator1 end1 () const;

            class iterator1:

                public container_reference<banded_matrix>,

                public random_access_iterator_base<iterator1, value_type> {

            public:

                typedef packed_random_access_iterator_tag iterator_category;

                typedef typename banded_matrix::difference_type difference_type;

                typedef typename banded_matrix::value_type value_type;

                typedef typename banded_matrix::reference reference;

                typedef typename banded_matrix::pointer pointer;

                typedef iterator2 dual_iterator_type;

                typedef reverse_iterator2 dual_reverse_iterator_type;

                // Construction and destruction

                iterator1 ();

                iterator1 (banded_matrix &m, size_type it1, size_type it2);

                // Arithmetic

                iterator1 &operator ++ ();

                iterator1 &operator -- ();

                iterator1 &operator += (difference_type n);

                iterator1 &operator -= (difference_type n);

                difference_type operator - (const iterator1 &it) const;

                // Dereference

                reference operator * () const;

                iterator2 begin () const;

                iterator2 end () const;

                reverse_iterator2 rbegin () const;

                reverse_iterator2 rend () const;

                // Indices

                size_type index1 () const;

                size_type index2 () const;

                // Assignment

                iterator1 &operator = (const iterator1 &it);

                // Comparison

                bool operator == (const iterator1 &it) const;

                bool operator < (const iterator1 &it) const;

            };

            iterator1 begin1 ();

            iterator1 end1 ();

            class const_iterator2:

                public container_const_reference<banded_matrix>,

                public random_access_iterator_base<const_iterator2, value_type> {

            public:

                typedef packed_random_access_iterator_tag iterator_category;

                typedef typename banded_matrix::difference_type difference_type;

                typedef typename banded_matrix::value_type value_type;

                typedef typename banded_matrix::const_reference reference;

                typedef typename banded_matrix::const_pointer pointer;

                typedef const_iterator1 dual_iterator_type;

                typedef const_reverse_iterator1 dual_reverse_iterator_type;

                // Construction and destruction

                const_iterator2 ();

                const_iterator2 (const banded_matrix &m, size_type it1, size_type it2);

                const_iterator2 (const iterator2 &it);

                // Arithmetic

                const_iterator2 &operator ++ ();

                const_iterator2 &operator -- ();

                const_iterator2 &operator += (difference_type n);

                const_iterator2 &operator -= (difference_type n);

                difference_type operator - (const const_iterator2 &it) const;

                // Dereference

                reference operator * () const;

                const_iterator1 begin () const;

                const_iterator1 end () const;

                const_reverse_iterator1 rbegin () const;

                const_reverse_iterator1 rend () const;

                // Indices

                size_type index1 () const;

                size_type index2 () const;

                // Assignment

                const_iterator2 &operator = (const const_iterator2 &it);

                // Comparison

                bool operator == (const const_iterator2 &it) const;

                bool operator < (const const_iterator2 &it) const;

            };

            const_iterator2 begin2 () const;

            const_iterator2 end2 () const;

            class iterator2:

                public container_reference<banded_matrix>,

                public random_access_iterator_base<iterator2, value_type> {

            public:

                typedef packed_random_access_iterator_tag iterator_category;

                typedef typename banded_matrix::difference_type difference_type;

                typedef typename banded_matrix::value_type value_type;

                typedef typename banded_matrix::reference reference;

                typedef typename banded_matrix::pointer pointer;

                typedef iterator1 dual_iterator_type;

                typedef reverse_iterator1 dual_reverse_iterator_type;

                // Construction and destruction

                iterator2 ();

                iterator2 (banded_matrix &m, size_type it1, size_type it2);

                // Arithmetic

                iterator2 &operator ++ ();

                iterator2 &operator -- ();

                iterator2 &operator += (difference_type n);

                iterator2 &operator -= (difference_type n);

                difference_type operator - (const iterator2 &it) const;

                // Dereference

                reference operator * () const;

                iterator1 begin () const;

                iterator1 end () const;

                reverse_iterator1 rbegin () const;

                reverse_iterator1 rend () const;

                // Indices

                size_type index1 () const;

                size_type index2 () const;

                // Assignment

                iterator2 &operator = (const iterator2 &it);

                // Comparison

                bool operator == (const iterator2 &it) const;

                bool operator < (const iterator2 &it) const;

            };

            iterator2 begin2 ();

            iterator2 end2 ();

            // Reverse iterators

            const_reverse_iterator1 rbegin1 () const;

            const_reverse_iterator1 rend1 () const;

            reverse_iterator1 rbegin1 ();

            reverse_iterator1 rend1 ();

            const_reverse_iterator2 rbegin2 () const;

            const_reverse_iterator2 rend2 () const;

            reverse_iterator2 rbegin2 ();

            reverse_iterator2 rend2 ();

        };

## Banded Adaptor

#### Description

The templated class `banded_adaptor<M>` is a banded matrix adaptor for other matrices.

#### Example

    int main () {

        using namespace boost::numeric::ublas;

        matrix<double> m (3, 3);

        banded_adaptor<matrix<double> > ba (m, 1, 1);

        for (int i = 0; i < ba.size1 (); ++ i)

            for (int j = std::max (i - 1, 0); j < std::min (i + 2, ba.size2 ()); ++ j)

                ba (i, j) = 3 * i + j;

        std::cout << ba << std::endl;

    }

#### Definition

Defined in the header banded.hpp.

#### Template parameters

Parameter | Description | Default
--- | --- | ---
`M` | The type of the adapted matrix. |

#### Model of

Matrix Expression.

#### Type requirements

None, except for those imposed by the requirements of Matrix Expression.

#### Public base classes

`matrix_expression<banded_adaptor<M> >`

#### Members

Member | Description
--- | ---
`banded_adaptor ()` | Constructs a `banded_adaptor` that holds zero rows of zero elements.
`banded_adaptor (matrix_type &data, size_type lower = 0, size_type upper = 0)` | Constructs a `banded_adaptor` that holds `(lower + 1 + upper)` diagonals around the main diagonal of a matrix.
`banded_adaptor (const banded_adaptor &m)` | The copy constructor.
`template<class AE> banded_adaptor (const matrix_expression<AE> &ae)` | The extended copy constructor.
`size_type size1 () const` | Returns the number of rows.
`size_type size2 () const` | Returns the number of columns.
`size_type lower () const` | Returns the number of diagonals below the main diagonal.
`size_type upper () const` | Returns the number of diagonals above the main diagonal.
`const_reference operator () (size_type i, size_type j) const` | Returns a `const` reference of the `j`-th element in the `i`-th row.
`reference operator () (size_type i, size_type j)` | Returns a reference of the `j`-th element in the `i`-th row.
`banded_adaptor &operator = (const banded_adaptor &m)` | The assignment operator.
`banded_adaptor &assign_temporary (banded_adaptor &m)` | Assigns a temporary. May change the banded adaptor `m`.
`template<class AE> banded_adaptor &operator = (const matrix_expression<AE> &ae)` | The extended assignment operator.
`template<class AE> banded_adaptor &assign (const matrix_expression<AE> &ae)` | Assigns a matrix expression to the banded adaptor. Left and right hand side of the assignment should be independent.
`template<class AE> banded_adaptor &operator += (const matrix_expression<AE> &ae)` | A computed assignment operator. Adds the matrix expression to the banded adaptor.
`template<class AE> banded_adaptor &plus_assign (const matrix_expression<AE> &ae)` | Adds a matrix expression to the banded adaptor. Left and right hand side of the assignment should be independent.
`template<class AE> banded_adaptor &operator -= (const matrix_expression<AE> &ae)` | A computed assignment operator. Subtracts the matrix expression from the banded adaptor.
`template<class AE> banded_adaptor &minus_assign (const matrix_expression<AE> &ae)` | Subtracts a matrix expression from the banded adaptor. Left and right hand side of the assignment should be independent.
`template<class AT> banded_adaptor &operator *= (const AT &at)` | A computed assignment operator. Multiplies the banded adaptor with a scalar.
`template<class AT> banded_adaptor &operator /= (const AT &at)` | A computed assignment operator. Divides the banded adaptor through a scalar.
`void swap (banded_adaptor &m)` | Swaps the contents of the banded adaptors.
`const_iterator1 begin1 () const` | Returns a `const_iterator1` pointing to the beginning of the `banded_adaptor`.
`const_iterator1 end1 () const` | Returns a `const_iterator1` pointing to the end of the `banded_adaptor`.
`iterator1 begin1 ()` | Returns a `iterator1` pointing to the beginning of the `banded_adaptor`.
`iterator1 end1 ()` | Returns a `iterator1` pointing to the end of the `banded_adaptor`.
`const_iterator2 begin2 () const` | Returns a `const_iterator2` pointing to the beginning of the `banded_adaptor`.
`const_iterator2 end2 () const` | Returns a `const_iterator2` pointing to the end of the `banded_adaptor`.
`iterator2 begin2 ()` | Returns a `iterator2` pointing to the beginning of the `banded_adaptor`.
`iterator2 end2 ()` | Returns a `iterator2` pointing to the end of the `banded_adaptor`.
`const_reverse_iterator1 rbegin1 () const` | Returns a `const_reverse_iterator1` pointing to the beginning of the reversed `banded_adaptor`.
`const_reverse_iterator1 rend1 () const` | Returns a `const_reverse_iterator1` pointing to the end of the reversed `banded_adaptor`.
`reverse_iterator1 rbegin1 ()` | Returns a `reverse_iterator1` pointing to the beginning of the reversed `banded_adaptor`.
`reverse_iterator1 rend1 ()` | Returns a `reverse_iterator1` pointing to the end of the reversed `banded_adaptor`.
`const_reverse_iterator2 rbegin2 () const` | Returns a `const_reverse_iterator2` pointing to the beginning of the reversed `banded_adaptor`.
`const_reverse_iterator2 rend2 () const` | Returns a `const_reverse_iterator2` pointing to the end of the reversed `banded_adaptor`.
`reverse_iterator2 rbegin2 ()` | Returns a `reverse_iterator2` pointing to the beginning of the reversed `banded_adaptor`.
`reverse_iterator2 rend2 ()` | Returns a `reverse_iterator2` pointing to the end of the reversed `banded_adaptor`.

#### Interface

        // Banded matrix adaptor class

        template<class M>

        class banded_adaptor:

            public matrix_expression<banded_adaptor<M> > {

        public:

            typedef const M const_matrix_type;

            typedef M matrix_type;

            typedef typename M::size_type size_type;

            typedef typename M::difference_type difference_type;

            typedef typename M::value_type value_type;

            typedef typename M::const_reference const_reference;

            typedef typename M::reference reference;

            typedef typename M::const_pointer const_pointer;

            typedef typename M::pointer pointer;

            typedef const banded_adaptor<M> const_self_type;

            typedef banded_adaptor<M> self_type;

            typedef const matrix_const_reference<const_self_type> const_closure_type;

            typedef matrix_reference<self_type> closure_type;

            typedef typename storage_restrict_traits<typename M::storage_category,

                                                     packed_proxy_tag>::storage_category storage_category;

            typedef typename M::orientation_category orientation_category;

            // Construction and destruction

            banded_adaptor ();

            banded_adaptor (matrix_type &data, size_type lower = 0, size_type upper = 0);

            banded_adaptor (const banded_adaptor &m);

            // Accessors

            size_type size1 () const;

            size_type size2 () const;

            size_type lower () const;

            size_type upper () const;

            const_matrix_type &data () const;

            matrix_type &data ();

            // Element access

            const_reference operator () (size_type i, size_type j) const;

            reference operator () (size_type i, size_type j);

            // Assignment

            banded_adaptor &operator = (const banded_adaptor &m);

            banded_adaptor &assign_temporary (banded_adaptor &m);

            template<class AE>

            banded_adaptor &operator = (const matrix_expression<AE> &ae);

            template<class AE>

            banded_adaptor &assign (const matrix_expression<AE> &ae);

            template<class AE>

            banded_adaptor& operator += (const matrix_expression<AE> &ae);

            template<class AE>

            banded_adaptor &plus_assign (const matrix_expression<AE> &ae);

            template<class AE>

            banded_adaptor& operator -= (const matrix_expression<AE> &ae);

            template<class AE>

            banded_adaptor &minus_assign (const matrix_expression<AE> &ae);

            template<class AT>

            banded_adaptor& operator *= (const AT &at);

            template<class AT>

            banded_adaptor& operator /= (const AT &at);

            // Swapping

            void swap (banded_adaptor &m);

            friend void swap (banded_adaptor &m1, banded_adaptor &m2);

            class const_iterator1;

            class iterator1;

            class const_iterator2;

            class iterator2;

            typedef reverse_iterator_base1<const_iterator1> const_reverse_iterator1;

            typedef reverse_iterator_base1<iterator1> reverse_iterator1;

            typedef reverse_iterator_base2<const_iterator2> const_reverse_iterator2;

            typedef reverse_iterator_base2<iterator2> reverse_iterator2;

            // Element lookup

            const_iterator1 find1 (int rank, size_type i, size_type j) const;

            iterator1 find1 (int rank, size_type i, size_type j);

            const_iterator2 find2 (int rank, size_type i, size_type j) const;

            iterator2 find2 (int rank, size_type i, size_type j);

            const_iterator1 find_first1 (int rank, size_type i, size_type j) const;

            iterator1 find_first1 (int rank, size_type i, size_type j);

            const_iterator1 find_last1 (int rank, size_type i, size_type j) const;

            iterator1 find_last1 (int rank, size_type i, size_type j);

            const_iterator2 find_first2 (int rank, size_type i, size_type j) const;

            iterator2 find_first2 (int rank, size_type i, size_type j);

            const_iterator2 find_last2 (int rank, size_type i, size_type j) const;

            iterator2 find_last2 (int rank, size_type i, size_type j);

            // Iterators simply are indices.

            class const_iterator1:

                public container_const_reference<banded_adaptor>,

                public random_access_iterator_base<const_iterator1, value_type> {

            public:

                typedef packed_random_access_iterator_tag iterator_category;

                typedef typename banded_adaptor::difference_type difference_type;

                typedef typename banded_adaptor::value_type value_type;

                typedef typename banded_adaptor::const_reference reference;

                typedef typename banded_adaptor::const_pointer pointer;

                typedef const_iterator2 dual_iterator_type;

                typedef const_reverse_iterator2 dual_reverse_iterator_type;

                // Construction and destruction

                const_iterator1 ();

                const_iterator1 (const banded_adaptor &m, size_type it1, size_type it2);

                const_iterator1 (const iterator1 &it);

                // Arithmetic

                const_iterator1 &operator ++ ();

                const_iterator1 &operator -- ();

                const_iterator1 &operator += (difference_type n);

                const_iterator1 &operator -= (difference_type n);

                difference_type operator - (const const_iterator1 &it) const;

                // Dereference

                reference operator * () const;

                const_iterator2 begin () const;

                const_iterator2 end () const;

                const_reverse_iterator2 rbegin () const;

                const_reverse_iterator2 rend () const;

                // Indices

                size_type index1 () const;

                size_type index2 () const;

                // Assignment

                const_iterator1 &operator = (const const_iterator1 &it);

                // Comparison

                bool operator == (const const_iterator1 &it) const;

                bool operator < (const const_iterator1 &it) const;

            };

            const_iterator1 begin1 () const;

            const_iterator1 end1 () const;

            class iterator1:

                public container_reference<banded_adaptor>,

                public random_access_iterator_base<iterator1, value_type> {

            public:

                typedef packed_random_access_iterator_tag iterator_category;

                typedef typename banded_adaptor::difference_type difference_type;

                typedef typename banded_adaptor::value_type value_type;

                typedef typename banded_adaptor::reference reference;

                typedef typename banded_adaptor::pointer pointer;

                typedef iterator2 dual_iterator_type;

                typedef reverse_iterator2 dual_reverse_iterator_type;

                // Construction and destruction

                iterator1 ();

                iterator1 (banded_adaptor &m, size_type it1, size_type it2);

                // Arithmetic

                iterator1 &operator ++ ();

                iterator1 &operator -- ();

                iterator1 &operator += (difference_type n);

                iterator1 &operator -= (difference_type n);

                difference_type operator - (const iterator1 &it) const;

                // Dereference

                reference operator * () const;

                iterator2 begin () const;

                iterator2 end () const;

                reverse_iterator2 rbegin () const;

                reverse_iterator2 rend () const;

                // Indices

                size_type index1 () const;

                size_type index2 () const;

                // Assignment

                iterator1 &operator = (const iterator1 &it);

                // Comparison

                bool operator == (const iterator1 &it) const;

                bool operator < (const iterator1 &it) const;

            };

            iterator1 begin1 ();

            iterator1 end1 ();

            class const_iterator2:

                public container_const_reference<banded_adaptor>,

                public random_access_iterator_base<const_iterator2, value_type> {

            public:

                typedef packed_random_access_iterator_tag iterator_category;

                typedef typename banded_adaptor::difference_type difference_type;

                typedef typename banded_adaptor::value_type value_type;

                typedef typename banded_adaptor::const_reference reference;

                typedef typename banded_adaptor::const_pointer pointer;

                typedef const_iterator1 dual_iterator_type;

                typedef const_reverse_iterator1 dual_reverse_iterator_type;

                // Construction and destruction

                const_iterator2 ();

                const_iterator2 (const banded_adaptor &m, size_type it1, size_type it2);

                const_iterator2 (const iterator2 &it);

                // Arithmetic

                const_iterator2 &operator ++ ();

                const_iterator2 &operator -- ();

                const_iterator2 &operator += (difference_type n);

                const_iterator2 &operator -= (difference_type n);

                difference_type operator - (const const_iterator2 &it) const;

                // Dereference

                reference operator * () const;

                const_iterator1 begin () const;

                const_iterator1 end () const;

                const_reverse_iterator1 rbegin () const;

                const_reverse_iterator1 rend () const;

                // Indices

                size_type index1 () const;

                size_type index2 () const;

                // Assignment

                const_iterator2 &operator = (const const_iterator2 &it);

                // Comparison

                bool operator == (const const_iterator2 &it) const;

                bool operator < (const const_iterator2 &it) const;

            };

            const_iterator2 begin2 () const;

            const_iterator2 end2 () const;

            class iterator2:

                public container_reference<banded_adaptor>,

                public random_access_iterator_base<iterator2, value_type> {

            public:

                typedef packed_random_access_iterator_tag iterator_category;

                typedef typename banded_adaptor::difference_type difference_type;

                typedef typename banded_adaptor::value_type value_type;

                typedef typename banded_adaptor::reference reference;

                typedef typename banded_adaptor::pointer pointer;

                typedef iterator1 dual_iterator_type;

                typedef reverse_iterator1 dual_reverse_iterator_type;

                // Construction and destruction

                iterator2 ();

                iterator2 (banded_adaptor &m, size_type it1, size_type it2);

                // Arithmetic

                iterator2 &operator ++ ();

                iterator2 &operator -- ();

                iterator2 &operator += (difference_type n);

                iterator2 &operator -= (difference_type n);

                difference_type operator - (const iterator2 &it) const;

                // Dereference

                reference operator * () const;

                iterator1 begin () const;

                iterator1 end () const;

                reverse_iterator1 rbegin () const;

                reverse_iterator1 rend () const;

                // Indices

                size_type index1 () const;

                size_type index2 () const;

                // Assignment

                iterator2 &operator = (const iterator2 &it);

                // Comparison

                bool operator == (const iterator2 &it) const;

                bool operator < (const iterator2 &it) const;

            };

            iterator2 begin2 ();

            iterator2 end2 ();

            // Reverse iterators

            const_reverse_iterator1 rbegin1 () const;

            const_reverse_iterator1 rend1 () const;

            reverse_iterator1 rbegin1 ();

            reverse_iterator1 rend1 ();

            const_reverse_iterator2 rbegin2 () const;

            const_reverse_iterator2 rend2 () const;

            reverse_iterator2 rbegin2 ();

            reverse_iterator2 rend2 ();

        };

Copyright (©) 2000-2002 Joerg Walter, Mathias Koch
Permission to copy, use, modify, sell and distribute this document is granted provided this copyright notice appears in all copies. This document is provided ``as is'' without express or implied warranty, and with no claim as to its suitability for any purpose.

Last revised: 8/3/2002