VISR  0.12.0
Versatile Interactive Scene Renderer
visr::rbbl::SparseGainRouting Struct Reference

#include <sparse_gain_routing.hpp>

Inheritance diagram for visr::rbbl::SparseGainRouting:
visr::pml::SparseGainRoutingParameter

Public Types

using IndexType = std::size_t
 
using GainType = float
 

Public Member Functions

 SparseGainRouting ()
 
 SparseGainRouting (IndexType pEntry, IndexType pRow, IndexType pColumn, GainType pGain=static_cast< GainType >(1.0))
 

Public Attributes

IndexType entryIndex
 
IndexType rowIndex
 
IndexType columnIndex
 
GainType gain
 

Static Public Attributes

static const IndexType cInvalidIndex = UINT_MAX
 

Detailed Description

Class for defining a routing entry for a multichannel filter engine. A routing entry consists of a input channel index, an output channel index, an index for the used filter coefficient, and a gain value.

Member Typedef Documentation

◆ GainType

◆ IndexType

Constructor & Destructor Documentation

◆ SparseGainRouting() [1/2]

visr::rbbl::SparseGainRouting::SparseGainRouting ( )
inline

Default constructor to create an object with invalid entry, input, and output indices.

◆ SparseGainRouting() [2/2]

visr::rbbl::SparseGainRouting::SparseGainRouting ( IndexType  pEntry,
IndexType  pRow,
IndexType  pColumn,
GainType  pGain = static_cast<GainType>(1.0) 
)
inline

Constructor with arguments.

Parameters
pEntryUnique index of the entry (zero-offset)
pRowRow index of the routing point (zero-offset)
pColumnColumn index of the routing point (zero-offset)
pGainInitial gain value, linear scale. Default: 1.0

Member Data Documentation

◆ cInvalidIndex

const IndexType visr::rbbl::SparseGainRouting::cInvalidIndex = UINT_MAX
static

Special value to denote invalid indices

Note
: std::numeric_limits<IndexType> would be nicer, but MSVC does not support constexpr yet.

◆ columnIndex

IndexType visr::rbbl::SparseGainRouting::columnIndex

The column index of the entry (zero-offset)

◆ entryIndex

IndexType visr::rbbl::SparseGainRouting::entryIndex

The index of the entry (zero-offset)

◆ gain

GainType visr::rbbl::SparseGainRouting::gain

The gain value for the routing point (linear scale)

◆ rowIndex

IndexType visr::rbbl::SparseGainRouting::rowIndex

The row index of the entry(zero-offset)


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