Public Types | Public Member Functions | Protected Types | Protected Attributes | List of all members
vbl_sparse_array_1d< T > Class Template Reference

Sparse array allowing space efficient access of the form s[3000] = 2;. More...

#include <vbl_fwd.h>

Inheritance diagram for vbl_sparse_array_1d< T >:
Inheritance graph
[legend]

Public Types

typedef vbl_sparse_array_base< T, unsigned >::const_iterator const_iterator
 
typedef std::size_t size_type
 
typedef unsigned Index_type
 The type of objects used to index the sparse array. More...
 
typedef T T_type
 The type of values stored by the sparse array. More...
 
typedef Map::value_type sequence_value_type
 The type of values of the controlled sequence. More...
 

Public Member Functions

std::ostream & print (std::ostream &out) const
 Print the Array to a stream in "(i,j): value" format. More...
 
T & operator() (unsigned i)
 Return contents at (i). More...
 
T const & operator() (unsigned i) const
 Return contents at (i). Asserts that (i) is non-empty. More...
 
void erase (unsigned)
 Erase element at location (i). Assertion failure if not yet filled. More...
 
bool fullp (unsigned) const
 Return true if location (i) has been filled. More...
 
bool put (unsigned, const T &)
 Put a value into location (i). More...
 
T * get_addr (unsigned)
 Return the address of location (i). 0 if not yet filled. More...
 
void clear ()
 Empty the sparse matrix. More...
 
size_type count_nonempty () const
 Return number of locations that have been assigned a value using "put". More...
 
const_iterator begin () const
 A bidirectional iterator pointing at the first non-empty element. More...
 
const_iterator end () const
 A bidirectional iterator pointing just beyond last non-empty element. More...
 

Protected Types

typedef std::map< unsigned, T, std::less< unsigned > > Map
 The type of the storage. More...
 

Protected Attributes

Map storage_
 This stores a compact list of the values. More...
 

Detailed Description

template<class T>
class vbl_sparse_array_1d< T >

Sparse array allowing space efficient access of the form s[3000] = 2;.

Definition at line 8 of file vbl_fwd.h.

Member Typedef Documentation

◆ const_iterator

template<class T>
typedef vbl_sparse_array_base<T,unsigned>::const_iterator vbl_sparse_array_1d< T >::const_iterator

Definition at line 26 of file vbl_sparse_array_1d.h.

◆ Index_type

typedef unsigned vbl_sparse_array_base< T, unsigned >::Index_type
inherited

The type of objects used to index the sparse array.

Definition at line 77 of file vbl_sparse_array_base.h.

◆ Map

typedef std::map<unsigned , T, std::less<unsigned > > vbl_sparse_array_base< T, unsigned >::Map
protectedinherited

The type of the storage.

Definition at line 41 of file vbl_sparse_array_base.h.

◆ sequence_value_type

typedef Map::value_type vbl_sparse_array_base< T, unsigned >::sequence_value_type
inherited

The type of values of the controlled sequence.

The value_type is a std::pair<Index_type, typename T_type>

Definition at line 84 of file vbl_sparse_array_base.h.

◆ size_type

typedef std::size_t vbl_sparse_array_base< T, unsigned >::size_type
inherited

Definition at line 47 of file vbl_sparse_array_base.h.

◆ T_type

typedef T vbl_sparse_array_base< T, unsigned >::T_type
inherited

The type of values stored by the sparse array.

Definition at line 80 of file vbl_sparse_array_base.h.

Member Function Documentation

◆ begin()

const_iterator vbl_sparse_array_base< T, unsigned >::begin ( ) const
inlineinherited

A bidirectional iterator pointing at the first non-empty element.

If the array is empty it points just beyond the end.

Definition at line 88 of file vbl_sparse_array_base.h.

◆ clear()

void vbl_sparse_array_base< T, unsigned >::clear ( )
inherited

Empty the sparse matrix.

Definition at line 18 of file vbl_sparse_array_base.hxx.

◆ count_nonempty()

size_type vbl_sparse_array_base< T, unsigned >::count_nonempty ( ) const
inlineinherited

Return number of locations that have been assigned a value using "put".

Definition at line 74 of file vbl_sparse_array_base.h.

◆ end()

const_iterator vbl_sparse_array_base< T, unsigned >::end ( ) const
inlineinherited

A bidirectional iterator pointing just beyond last non-empty element.

Definition at line 91 of file vbl_sparse_array_base.h.

◆ erase()

void vbl_sparse_array_base< T, unsigned >::erase ( unsigned  i)
inherited

Erase element at location (i). Assertion failure if not yet filled.

Definition at line 36 of file vbl_sparse_array_base.hxx.

◆ fullp()

bool vbl_sparse_array_base< T, unsigned >::fullp ( unsigned  i) const
inherited

Return true if location (i) has been filled.

Definition at line 59 of file vbl_sparse_array_base.hxx.

◆ get_addr()

T * vbl_sparse_array_base< T, unsigned >::get_addr ( unsigned  i)
inherited

Return the address of location (i). 0 if not yet filled.

Return the memory address of location (i). 0 if not yet filled.

Definition at line 47 of file vbl_sparse_array_base.hxx.

◆ operator()() [1/2]

T& vbl_sparse_array_base< T, unsigned >::operator() ( unsigned  i)
inlineinherited

Return contents at (i).

Definition at line 50 of file vbl_sparse_array_base.h.

◆ operator()() [2/2]

T const & vbl_sparse_array_base< T, unsigned >::operator() ( unsigned  i) const
inherited

Return contents at (i). Asserts that (i) is non-empty.

Return contents of (i). Assertion failure if not yet filled.

Definition at line 25 of file vbl_sparse_array_base.hxx.

◆ print()

template<class T>
std::ostream& vbl_sparse_array_1d< T >::print ( std::ostream &  out) const
inline

Print the Array to a stream in "(i,j): value" format.

Definition at line 29 of file vbl_sparse_array_1d.h.

◆ put()

bool vbl_sparse_array_base< T, unsigned >::put ( unsigned  i,
const T &  t 
)
inherited

Put a value into location (i).

Definition at line 66 of file vbl_sparse_array_base.hxx.

Member Data Documentation

◆ storage_

Map vbl_sparse_array_base< T, unsigned >::storage_
protectedinherited

This stores a compact list of the values.

Definition at line 43 of file vbl_sparse_array_base.h.


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