shark::Batch< shark::blas::compressed_vector< T > > Struct Template Reference

specialization for ublas compressed vectors which are compressed matrices in batch mode! More...

#include <shark/Data/BatchInterface.h>

Public Types

typedef detail::MatrixRowReference< type > reference
 Type of a single element. More...
 
typedef detail::MatrixRowReference< const type > const_reference
 Type of a single immutable element. More...
 
typedef ProxyIterator< type, value_type, referenceiterator
 the iterator type of the object More...
 
typedef ProxyIterator< const type, value_type, const_referenceconst_iterator
 the const_iterator type of the object More...
 

Static Public Member Functions

template<class Element >
static type createBatch (Element const &input, std::size_t size=1)
 creates a batch with input as size blueprint More...
 
template<class Iterator >
static type createBatchFromRange (Iterator const &start, Iterator const &end)
 creates a batch storing the elements referenced by the provided range More...
 
static void resize (type &batch, std::size_t batchSize, std::size_t elements)
 
static std::size_t size (type const &batch)
 
static reference get (type &batch, std::size_t i)
 
static const_reference get (type const &batch, std::size_t i)
 
static iterator begin (type &batch)
 
static const_iterator begin (type const &batch)
 
static iterator end (type &batch)
 
static const_iterator end (type const &batch)
 

Detailed Description

template<class T>
struct shark::Batch< shark::blas::compressed_vector< T > >

specialization for ublas compressed vectors which are compressed matrices in batch mode!

Definition at line 246 of file BatchInterface.h.

Member Typedef Documentation

◆ const_iterator

template<class T >
typedef ProxyIterator<const type, value_type, const_reference > shark::Batch< shark::blas::compressed_vector< T > >::const_iterator

the const_iterator type of the object

Definition at line 263 of file BatchInterface.h.

◆ const_reference

template<class T >
typedef detail::MatrixRowReference<const type> shark::Batch< shark::blas::compressed_vector< T > >::const_reference

Type of a single immutable element.

Definition at line 257 of file BatchInterface.h.

◆ iterator

template<class T >
typedef ProxyIterator<type, value_type, reference > shark::Batch< shark::blas::compressed_vector< T > >::iterator

the iterator type of the object

Definition at line 261 of file BatchInterface.h.

◆ reference

template<class T >
typedef detail::MatrixRowReference<type> shark::Batch< shark::blas::compressed_vector< T > >::reference

Type of a single element.

Definition at line 255 of file BatchInterface.h.

Member Function Documentation

◆ begin() [1/2]

template<class T >
static iterator shark::Batch< shark::blas::compressed_vector< T > >::begin ( type &  batch)
inlinestatic

Definition at line 297 of file BatchInterface.h.

◆ begin() [2/2]

template<class T >
static const_iterator shark::Batch< shark::blas::compressed_vector< T > >::begin ( type const &  batch)
inlinestatic

Definition at line 300 of file BatchInterface.h.

◆ createBatch()

template<class T >
template<class Element >
static type shark::Batch< shark::blas::compressed_vector< T > >::createBatch ( Element const &  input,
std::size_t  size = 1 
)
inlinestatic

creates a batch with input as size blueprint

Definition at line 267 of file BatchInterface.h.

◆ createBatchFromRange()

template<class T >
template<class Iterator >
static type shark::Batch< shark::blas::compressed_vector< T > >::createBatchFromRange ( Iterator const &  start,
Iterator const &  end 
)
inlinestatic

creates a batch storing the elements referenced by the provided range

Definition at line 272 of file BatchInterface.h.

◆ end() [1/2]

template<class T >
static iterator shark::Batch< shark::blas::compressed_vector< T > >::end ( type &  batch)
inlinestatic

Definition at line 304 of file BatchInterface.h.

◆ end() [2/2]

template<class T >
static const_iterator shark::Batch< shark::blas::compressed_vector< T > >::end ( type const &  batch)
inlinestatic

Definition at line 307 of file BatchInterface.h.

◆ get() [1/2]

template<class T >
static reference shark::Batch< shark::blas::compressed_vector< T > >::get ( type &  batch,
std::size_t  i 
)
inlinestatic

Definition at line 290 of file BatchInterface.h.

◆ get() [2/2]

template<class T >
static const_reference shark::Batch< shark::blas::compressed_vector< T > >::get ( type const &  batch,
std::size_t  i 
)
inlinestatic

Definition at line 293 of file BatchInterface.h.

◆ resize()

template<class T >
static void shark::Batch< shark::blas::compressed_vector< T > >::resize ( type &  batch,
std::size_t  batchSize,
std::size_t  elements 
)
inlinestatic

Definition at line 285 of file BatchInterface.h.

◆ size()

template<class T >
static std::size_t shark::Batch< shark::blas::compressed_vector< T > >::size ( type const &  batch)
inlinestatic

Definition at line 289 of file BatchInterface.h.


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