sparse_vector.h File Reference

Class defining a sparse vector (holes are zeroes) More...

#include <cstddef>
#include <stdexcept>
#include <vector>
#include <ostream>
#include <iterator>
#include <algorithm>
#include <numeric>
#include <type_traits>

Go to the source code of this file.

Classes
class	lar::const_value_box< T >
	Little class storing a value. More...
class	lar::value_const_iterator< T >
	A constant iterator returning always the same value. More...
class	lar::range_t< SIZE >
	A range (interval) of integers. More...
class	lar::sparse_vector< T >
	A sparse vector. More...
class	lar::sparse_vector< T >::datarange_t
	Range class, with range and data. More...
class	lar::sparse_vector< T >::const_reference
	Special little box to allow void elements to be treated as references. More...
class	lar::sparse_vector< T >::reference
	A class representing a cell in a sparse vector. More...
class	lar::sparse_vector< T >::const_iterator
	Iterator to the sparse vector values. More...
struct	lar::sparse_vector< T >::const_iterator::special
	Namespace for special initialization. More...
class	lar::sparse_vector< T >::const_iterator::special::begin
class	lar::sparse_vector< T >::const_iterator::special::end
class	lar::sparse_vector< T >::iterator
	Iterator to the sparse vector values. More...

Namespaces
	lar
	LArSoft-specific namespace.

Functions
template<typename T >
value_const_iterator< T >	lar::operator+ (typename value_const_iterator< T >::difference_type ofs, value_const_iterator< T > &iter)
	Returns an iterator pointing ahead of this one by the specified steps. More...
template<typename T >
std::ostream &	operator<< (std::ostream &out, const lar::sparse_vector< T > &v)
	Prints a sparse vector into a stream. More...

Detailed Description

Class defining a sparse vector (holes are zeroes)

Author

Gianluca Petrillo (petri.nosp@m.llo@.nosp@m.fnal..nosp@m.gov)

Date

April 22, 2014

Version

1.0

Definition in file sparse_vector.h.

Function Documentation

template<typename T >

std::ostream & operator<<	(	std::ostream &	out,
		const lar::sparse_vector< T > &	v
	)

Prints a sparse vector into a stream.

Template Parameters

T	template type of the sparse vector

Parameters

out	output stream
v	the sparse vector to be written

Returns

the output stream (out)

The output is in the form:

Sparse vector of size ## with ## ranges:
  [min1 - max1] (size1) { elements of the first range }
  [min2 - max2] (size2) { elements of the second range }
  ...

Definition at line 1830 of file sparse_vector.h.

References lar::sparse_vector< T >::begin(), lar::sparse_vector< T >::end(), lar::sparse_vector< T >::datarange_t::extend(), and lar::sparse_vector< T >::size().

                                                                       {
        
        out << "Sparse vector of size " << v.size() << " with "
                << v.get_ranges().size() << " ranges:";
        typename lar::sparse_vector<T>::range_const_iterator
                iRange = v.begin_range(), rend = v.end_range();
        while (iRange != rend) {
                out << "\n  [" << iRange->begin_index() << " - " << iRange->end_index()
                        << "] (" << iRange->size() << "):";
                typename lar::sparse_vector<T>::datarange_t::const_iterator
                        iValue = iRange->begin(), vend = iRange->end();
                while (iValue != vend) out << " " << (*(iValue++));
                ++iRange;
        } // for
        return out << std::endl;
} // operator<< (ostream, sparse_vector<T>)