lar::sparse_vector< T >::datarange_t Class Reference

Range class, with range and data. More...

#include "sparse_vector.h"

Inheritance diagram for lar::sparse_vector< T >::datarange_t:

Public Types
typedef range_t< size_type >	base_t
	base class More...
typedef vector_t::iterator	iterator
typedef vector_t::const_iterator	const_iterator
typedef size_type	size_type
	type for the indices in the range More...
typedef std::ptrdiff_t	difference_type
	type for index difference More...
typedef bool(*	less_int_range) (size_type, const range_t &b)
	Helper type to be used for binary searches. More...

Public Member Functions
	datarange_t ()
	Default constructor: an empty range. More...
	datarange_t (const base_t &range)
	Constructor: range initialized with 0. More...
template<typename ITER >
	datarange_t (size_type offset, ITER first, ITER last)
	Constructor: offset and data. More...
	datarange_t (size_type offset, vector_t &&data)
	Constructor: offset and data as a vector (which will be used directly) More...
template<typename ITER >
datarange_t &	extend (size_type index, ITER first, ITER last)
	Appends the specified elements to this range. More...
void	move_head (size_type to_index, value_type def_value=value_zero)
	Moves the begin of this range. More...
void	move_tail (size_type to_index, value_type def_value=value_zero)
	Moves the end of this range. More...
template<typename Stream >
void	dump (Stream &&out) const
	Dumps the content of this data range into a stream. More...
template<typename ITER >
lar::sparse_vector< T >::datarange_t &	extend (size_type index, ITER first, ITER last)
void	set (size_type from, size_type to)
	Sets the borders of the range. More...
size_type	begin_index () const
	Returns the first absolute index included in the range. More...
size_type	end_index () const
	Returns the first absolute index not included in the range. More...
size_type	relative_index (size_type index) const
	Returns the position within the range of the absolute index specified. More...
size_type	size () const
	Returns the size of the range. More...
void	resize (size_type new_size)
	Moves the end of the range to fit the specified size. More...
void	move_head (difference_type shift)
	Moves the begin of the range by the specified amount. More...
void	move_tail (difference_type shift)
	Moves the end of the range by the specified amount. More...
bool	empty () const
	Returns whether the range is empty. More...
bool	includes (size_type index) const
	Returns whether the specified absolute index is included in this range. More...
bool	includes (const range_t &r) const
	Returns whether the specified range is completely included in this one. More...
bool	overlap (const range_t &r) const
	Returns if this and the specified range overlap. More...
bool	separate (const range_t &r) const
	Returns if there are elements in between this and the specified range. More...
bool	borders (size_type index) const
	Returns whether an index is within or immediately after this range. More...
bool	operator== (const range_t &as) const
	Returns whether the specified range has our same offset and size. More...
bool	is_valid () const
	Returns whether the range is valid (that is, non-negative size) More...
iterator	get_iterator (size_type index)
	Returns an iterator to the specified absolute value (no check!) More...
const_iterator	get_iterator (size_type index) const
	Returns an iterator to the specified absolute value (no check!) More...
const_iterator	get_const_iterator (size_type index) const
	Returns an iterator to the specified absolute value (no check!) More...
iterator	begin ()
	begin and end iterators More...
iterator	end ()
	begin and end iterators More...
const_iterator	begin () const
	begin and end iterators More...
const_iterator	end () const
	begin and end iterators More...
const_iterator	cbegin () const
	begin and end iterators More...
const_iterator	cend () const
	begin and end iterators More...
void	resize (size_t new_size)
	Resizes the range (optionally filling the new elements with def_value) More...
void	resize (size_t new_size, value_type def_value)
	Resizes the range (optionally filling the new elements with def_value) More...
value_type &	operator[] (size_type index)
	Returns the value at the specified absolute index. More...
const value_type &	operator[] (size_type index) const
	Returns the value at the specified absolute index. More...
const vector_t &	data () const
	Return the vector of data values. More...
bool	operator< (const range_t &than) const
	Sort: this range is smaller if its offset is smaller. More...

Static Public Member Functions
static bool	less (const range_t &a, const range_t &b)
	Returns if a is "less" than b. More...
static bool	less (const range_t &a, size_type b)
	Returns if a is "less" than b. More...
static bool	less (size_type a, const range_t &b)
	Returns if a is "less" than b. More...

Public Attributes
size_type	offset
	offset (absolute index) of the first element More...
size_type	last
	offset (absolute index) after the last element More...

Protected Member Functions
void	fit_size_from_data ()

Protected Attributes
vector_t	values
	data in the range More...

Detailed Description

template<typename T>
class lar::sparse_vector< T >::datarange_t

Range class, with range and data.

Definition at line 1232 of file sparse_vector.h.

Member Typedef Documentation

template<typename T>

typedef range_t<size_type> lar::sparse_vector< T >::datarange_t::base_t

base class

Definition at line 1234 of file sparse_vector.h.

template<typename T>

typedef vector_t::const_iterator lar::sparse_vector< T >::datarange_t::const_iterator

Definition at line 1237 of file sparse_vector.h.

typedef std::ptrdiff_t lar::range_t< size_type >::difference_type

inherited

type for index difference

Definition at line 206 of file sparse_vector.h.

template<typename T>

typedef vector_t::iterator lar::sparse_vector< T >::datarange_t::iterator

Definition at line 1236 of file sparse_vector.h.

typedef bool(* lar::range_t< size_type >::less_int_range) (size_type, const range_t &b)

inherited

Helper type to be used for binary searches.

Definition at line 296 of file sparse_vector.h.

typedef size_type lar::range_t< size_type >::size_type

inherited

type for the indices in the range

Definition at line 205 of file sparse_vector.h.

Constructor & Destructor Documentation

template<typename T>

lar::sparse_vector< T >::datarange_t::datarange_t ( )

inline

Default constructor: an empty range.

Definition at line 1240 of file sparse_vector.h.

: base_t(), values() {}

template<typename T>

lar::sparse_vector< T >::datarange_t::datarange_t ( const base_t &  range )

inline

Constructor: range initialized with 0.

Definition at line 1243 of file sparse_vector.h.

: base_t(range), values(range.size()) {}

template<typename T>

template<typename ITER >

lar::sparse_vector< T >::datarange_t::datarange_t ( size_type  offset, ITER  first, ITER  last  )

inline

Constructor: offset and data.

Definition at line 1247 of file sparse_vector.h.

    : base_t(offset, offset + std::distance(first, last)), values(first, last)
  {}

template<typename T>

lar::sparse_vector< T >::datarange_t::datarange_t ( size_type  offset, vector_t &&  data  )

inline

Constructor: offset and data as a vector (which will be used directly)

Definition at line 1252 of file sparse_vector.h.

References util::values().

    : base_t(offset, offset + data.size()), values(data)
  {}

Member Function Documentation

template<typename T>

iterator lar::sparse_vector< T >::datarange_t::begin ( )

inline

begin and end iterators

Definition at line 1268 of file sparse_vector.h.

Referenced by lar::sparse_vector< T >::unset_at().

{ return values.begin(); }

template<typename T>

const_iterator lar::sparse_vector< T >::datarange_t::begin ( ) const

inline

begin and end iterators

Definition at line 1270 of file sparse_vector.h.

References util::values().

{ return values.begin(); }

size_type lar::range_t< size_type >::begin_index ( ) const

inlineinherited

Returns the first absolute index included in the range.

Definition at line 227 of file sparse_vector.h.

{ return offset; }

bool lar::range_t< size_type >::borders ( size_type  index ) const

inlineinherited

Returns whether an index is within or immediately after this range.

Returns whether the specified absolute index is included in this range or is immediately after it (not before it!)

Definition at line 275 of file sparse_vector.h.

References geo::operator<().

{ return (index >= offset) && (index <= last); }

template<typename T>

const_iterator lar::sparse_vector< T >::datarange_t::cbegin ( ) const

inline

begin and end iterators

Definition at line 1272 of file sparse_vector.h.

References util::values().

{ return values.cbegin(); }

template<typename T>

const_iterator lar::sparse_vector< T >::datarange_t::cend ( ) const

inline

begin and end iterators

Definition at line 1273 of file sparse_vector.h.

References util::values().

{ return values.cend(); }

template<typename T>

const vector_t& lar::sparse_vector< T >::datarange_t::data ( ) const

inline

Return the vector of data values.

Definition at line 1301 of file sparse_vector.h.

{ return values; }

template<typename T >

template<typename Stream >

void lar::sparse_vector< T >::datarange_t::dump

(

Stream &&

out

)

const

Dumps the content of this data range into a stream.

Template Parameters

Stream

type of stream to sent the dump to

Parameters

out	stream to sent the dump to

The output format is:

[min - max] (size) { values... }

Output is on a single line, which is not terminated.

Definition at line 2390 of file sparse_vector.h.

References util::size(), and util::values().

{
  out << "[" << this->begin_index() << " - " << this->end_index() << "] (" << this->size()
      << "): {";
  for (auto const& v : this->values)
    out << " " << v;
  out << " }";
} // lar::sparse_vector<T>::datarange_t::dump()

bool lar::range_t< size_type >::empty ( ) const

inlineinherited

Returns whether the range is empty.

Definition at line 248 of file sparse_vector.h.

{ return last <= offset; }

template<typename T>

iterator lar::sparse_vector< T >::datarange_t::end ( )

inline

begin and end iterators

Definition at line 1269 of file sparse_vector.h.

References util::values().

Referenced by lar::sparse_vector< T >::unset_at().

{ return values.end(); }

template<typename T>

const_iterator lar::sparse_vector< T >::datarange_t::end ( ) const

inline

begin and end iterators

Definition at line 1271 of file sparse_vector.h.

References util::values().

{ return values.end(); }

size_type lar::range_t< size_type >::end_index ( ) const

inlineinherited

Returns the first absolute index not included in the range.

Definition at line 230 of file sparse_vector.h.

{ return last; }

template<typename T>

template<typename ITER >

datarange_t& lar::sparse_vector< T >::datarange_t::extend	(	size_type	index,
		ITER	first,
		ITER	last
	)

Appends the specified elements to this range.

Template Parameters

ITER	type of iterator of the range

Parameters

index	the starting point
first	iterator to the first object to copy
last	iterator after the last object to copy

Returns

the extended range

Referenced by lar::sparse_vector< T >::merge_ranges().

template<typename T>

template<typename ITER >

lar::sparse_vector<T>::datarange_t& lar::sparse_vector< T >::datarange_t::extend	(	size_type	index,
		ITER	first,
		ITER	last
	)

Definition at line 2362 of file sparse_vector.h.

References util::size(), and util::values().

{
  size_type new_size =
    std::max(base_t::relative_index(index) + std::distance(first, last), base_t::size());
  base_t::resize(new_size);
  values.resize(new_size);
  std::copy(first, last, get_iterator(index));
  return *this;
} // lar::sparse_vector<T>::datarange_t::extend()

template<typename T>

void lar::sparse_vector< T >::datarange_t::fit_size_from_data ( )

inlineprotected

Definition at line 1350 of file sparse_vector.h.

{ base_t::resize(values.size()); }

template<typename T>

const_iterator lar::sparse_vector< T >::datarange_t::get_const_iterator ( size_type  index ) const

inline

Returns an iterator to the specified absolute value (no check!)

Definition at line 1260 of file sparse_vector.h.

References util::begin(), and util::values().

  {
    return values.begin() + index - base_t::begin_index();
  }

template<typename T>

iterator lar::sparse_vector< T >::datarange_t::get_iterator ( size_type  index )

inline

Returns an iterator to the specified absolute value (no check!)

Definition at line 1258 of file sparse_vector.h.

{ return values.begin() + index - base_t::begin_index(); }

template<typename T>

const_iterator lar::sparse_vector< T >::datarange_t::get_iterator ( size_type  index ) const

inline

Returns an iterator to the specified absolute value (no check!)

Definition at line 1259 of file sparse_vector.h.

{ return get_const_iterator(index); }

bool lar::range_t< size_type >::includes ( size_type  index ) const

inlineinherited

Returns whether the specified absolute index is included in this range.

Definition at line 251 of file sparse_vector.h.

{ return (index >= offset) && (index < last); }

bool lar::range_t< size_type >::includes ( const range_t< size_type > &  r ) const

inlineinherited

Returns whether the specified range is completely included in this one.

Definition at line 254 of file sparse_vector.h.

References lar::range_t< SIZE >::begin_index(), and lar::range_t< SIZE >::end_index().

    {
      return includes(r.begin_index()) && includes(r.end_index());
    }

bool lar::range_t< size_type >::is_valid ( ) const

inlineinherited

Returns whether the range is valid (that is, non-negative size)

Definition at line 286 of file sparse_vector.h.

References lar::range_t< SIZE >::offset.

{ return last >= offset; }

static bool lar::range_t< size_type >::less ( const range_t< size_type > &  a, const range_t< size_type > &  b  )

inlinestaticinherited

Returns if a is "less" than b.

Definition at line 290 of file sparse_vector.h.

{ return a.offset < b.offset; }

static bool lar::range_t< size_type >::less ( const range_t< size_type > &  a, size_type  b  )

inlinestaticinherited

Returns if a is "less" than b.

Definition at line 291 of file sparse_vector.h.

References lar::range_t< SIZE >::offset.

{ return a.offset < b; }

static bool lar::range_t< size_type >::less ( size_type  a, const range_t< size_type > &  b  )

inlinestaticinherited

Returns if a is "less" than b.

Definition at line 292 of file sparse_vector.h.

References lar::range_t< SIZE >::offset.

{ return a < b.offset; }

void lar::range_t< size_type >::move_head ( difference_type  shift )

inlineinherited

Moves the begin of the range by the specified amount.

Definition at line 242 of file sparse_vector.h.

{ offset += shift; }

template<typename T >

void lar::sparse_vector< T >::datarange_t::move_head	(	size_type	to_index,
		value_type	def_value = value_zero
	)

Moves the begin of this range.

Parameters

to_index	absolute index to move the head to
def_value	value to be inserted in case of expansion of the range

Definition at line 2373 of file sparse_vector.h.

References util::values().

Referenced by lar::sparse_vector< T >::unset_at().

{
  difference_type delta = to_index - base_t::begin_index();
  if (delta == 0) return;
  base_t::move_head(delta);
  if (delta > 0) // shrink
    values.erase(values.begin(), values.begin() + delta);
  else { // extend
    values.insert(values.begin(),
                  value_const_iterator<value_type>(def_value),
                  value_const_iterator<value_type>(def_value) - delta);
  }
} // lar::sparse_vector<T>::datarange_t::move_head()

void lar::range_t< size_type >::move_tail ( difference_type  shift )

inlineinherited

Moves the end of the range by the specified amount.

Definition at line 245 of file sparse_vector.h.

{ last += shift; }

template<typename T>

void lar::sparse_vector< T >::datarange_t::move_tail ( size_type  to_index, value_type  def_value = value_zero  )

inline

Moves the end of this range.

Parameters

to_index	absolute index to move the tail to
def_value	value to be inserted in case of expansion of the range

Definition at line 1328 of file sparse_vector.h.

Referenced by lar::sparse_vector< T >::unset_at().

  {
    resize(base_t::relative_index(to_index), def_value);
  }

bool lar::range_t< size_type >::operator< ( const range_t< size_type > &  than ) const

inlineinherited

Sort: this range is smaller if its offset is smaller.

Definition at line 279 of file sparse_vector.h.

{ return less(*this, than); }

bool lar::range_t< size_type >::operator== ( const range_t< size_type > &  as ) const

inlineinherited

Returns whether the specified range has our same offset and size.

Definition at line 283 of file sparse_vector.h.

References lar::range_t< SIZE >::last, and lar::range_t< SIZE >::offset.

{ return (offset == as.offset) && (last == as.last); }

template<typename T>

value_type& lar::sparse_vector< T >::datarange_t::operator[] ( size_type  index )

inline

Returns the value at the specified absolute index.

Definition at line 1292 of file sparse_vector.h.

{ return values[base_t::relative_index(index)]; }

template<typename T>

const value_type& lar::sparse_vector< T >::datarange_t::operator[] ( size_type  index ) const

inline

Returns the value at the specified absolute index.

Definition at line 1293 of file sparse_vector.h.

References util::values().

  {
    return values[base_t::relative_index(index)];
  }

bool lar::range_t< size_type >::overlap ( const range_t< size_type > &  r ) const

inlineinherited

Returns if this and the specified range overlap.

Definition at line 260 of file sparse_vector.h.

References lar::range_t< SIZE >::begin_index(), and lar::range_t< SIZE >::end_index().

    {
      return (begin_index() < r.end_index()) && (end_index() > r.begin_index());
    }

size_type lar::range_t< size_type >::relative_index ( size_type  index ) const

inlineinherited

Returns the position within the range of the absolute index specified.

Definition at line 233 of file sparse_vector.h.

{ return index - offset; }

void lar::range_t< size_type >::resize ( size_type  new_size )

inlineinherited

Moves the end of the range to fit the specified size.

Definition at line 239 of file sparse_vector.h.

{ last = offset + new_size; }

template<typename T>

void lar::sparse_vector< T >::datarange_t::resize ( size_t  new_size )

inline

Resizes the range (optionally filling the new elements with def_value)

Definition at line 1278 of file sparse_vector.h.

  {
    values.resize(new_size);
    fit_size_from_data();
  }

template<typename T>

void lar::sparse_vector< T >::datarange_t::resize ( size_t  new_size, value_type  def_value  )

inline

Resizes the range (optionally filling the new elements with def_value)

Definition at line 1283 of file sparse_vector.h.

References util::values().

  {
    values.resize(new_size, def_value);
    fit_size_from_data();
  }

bool lar::range_t< size_type >::separate ( const range_t< size_type > &  r ) const

inlineinherited

Returns if there are elements in between this and the specified range.

Definition at line 266 of file sparse_vector.h.

References lar::range_t< SIZE >::begin_index(), and lar::range_t< SIZE >::end_index().

    {
      return (begin_index() > r.end_index()) || (end_index() < r.begin_index());
    }

void lar::range_t< size_type >::set ( size_type  from, size_type  to  )

inlineinherited

Sets the borders of the range.

Definition at line 220 of file sparse_vector.h.

    {
      offset = from;
      last = std::max(from, to);
    }

size_type lar::range_t< size_type >::size ( void  ) const

inlineinherited

Returns the size of the range.

Definition at line 236 of file sparse_vector.h.

{ return last - offset; }

Member Data Documentation

size_type lar::range_t< size_type >::last

inherited

offset (absolute index) after the last element

Definition at line 211 of file sparse_vector.h.

size_type lar::range_t< size_type >::offset

inherited

offset (absolute index) of the first element

Definition at line 208 of file sparse_vector.h.

template<typename T>

vector_t lar::sparse_vector< T >::datarange_t::values

protected

data in the range

Definition at line 1348 of file sparse_vector.h.

---

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

• lardataobj/v09_18_03/source/lardataobj/Utilities/sparse_vector.h