Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
uavcan::SquareMatrixAnalyzer< ElementIterator, NumElements > Class Template Reference

#include <array.hpp>

Inheritance diagram for uavcan::SquareMatrixAnalyzer< ElementIterator, NumElements >:
Inheritance graph
[legend]

Public Types

enum  PackingMode {
  PackingModeEmpty, PackingModeScalar, PackingModeDiagonal, PackingModeSymmetric,
  PackingModeFull
}
 
- Public Types inherited from uavcan::SquareMatrixTraits< NumElements >
enum  
 
enum  
 
enum  
 

Public Member Functions

ElementIterator accessElementAtRowCol (int row, int col) const
 
bool areAllElementsNan () const
 
PackingMode detectOptimalPackingMode () const
 
bool isDiagonal () const
 
bool isScalar () const
 
bool isSymmetric () const
 
 SquareMatrixAnalyzer (ElementIterator first_element_iterator)
 

Private Types

typedef SquareMatrixTraits< NumElementsTraits
 

Private Attributes

const ElementIterator first_
 

Additional Inherited Members

- Static Public Member Functions inherited from uavcan::SquareMatrixTraits< NumElements >
static int computeElementIndexAtRowCol (int row, int col)
 
static bool isIndexOnDiagonal (unsigned index)
 

Detailed Description

template<typename ElementIterator, unsigned NumElements>
class uavcan::SquareMatrixAnalyzer< ElementIterator, NumElements >

This class can be used to detect properties of square matrices. Element iterator is a random access forward constant iterator.

Definition at line 59 of file array.hpp.

Member Typedef Documentation

◆ Traits

template<typename ElementIterator , unsigned NumElements>
typedef SquareMatrixTraits<NumElements> uavcan::SquareMatrixAnalyzer< ElementIterator, NumElements >::Traits
private

Definition at line 61 of file array.hpp.

Member Enumeration Documentation

◆ PackingMode

template<typename ElementIterator , unsigned NumElements>
enum uavcan::SquareMatrixAnalyzer::PackingMode
Enumerator
PackingModeEmpty 
PackingModeScalar 
PackingModeDiagonal 
PackingModeSymmetric 
PackingModeFull 

Definition at line 66 of file array.hpp.

Constructor & Destructor Documentation

◆ SquareMatrixAnalyzer()

template<typename ElementIterator , unsigned NumElements>
uavcan::SquareMatrixAnalyzer< ElementIterator, NumElements >::SquareMatrixAnalyzer ( ElementIterator  first_element_iterator)
inline

Definition at line 75 of file array.hpp.

Member Function Documentation

◆ accessElementAtRowCol()

template<typename ElementIterator , unsigned NumElements>
ElementIterator uavcan::SquareMatrixAnalyzer< ElementIterator, NumElements >::accessElementAtRowCol ( int  row,
int  col 
) const
inline

Definition at line 81 of file array.hpp.

◆ areAllElementsNan()

template<typename ElementIterator , unsigned NumElements>
bool uavcan::SquareMatrixAnalyzer< ElementIterator, NumElements >::areAllElementsNan ( ) const
inline

Definition at line 86 of file array.hpp.

◆ detectOptimalPackingMode()

template<typename ElementIterator , unsigned NumElements>
PackingMode uavcan::SquareMatrixAnalyzer< ElementIterator, NumElements >::detectOptimalPackingMode ( ) const
inline

Definition at line 147 of file array.hpp.

◆ isDiagonal()

template<typename ElementIterator , unsigned NumElements>
bool uavcan::SquareMatrixAnalyzer< ElementIterator, NumElements >::isDiagonal ( ) const
inline

Definition at line 116 of file array.hpp.

◆ isScalar()

template<typename ElementIterator , unsigned NumElements>
bool uavcan::SquareMatrixAnalyzer< ElementIterator, NumElements >::isScalar ( ) const
inline

Definition at line 99 of file array.hpp.

◆ isSymmetric()

template<typename ElementIterator , unsigned NumElements>
bool uavcan::SquareMatrixAnalyzer< ElementIterator, NumElements >::isSymmetric ( ) const
inline

Definition at line 129 of file array.hpp.

Member Data Documentation

◆ first_

template<typename ElementIterator , unsigned NumElements>
const ElementIterator uavcan::SquareMatrixAnalyzer< ElementIterator, NumElements >::first_
private

Definition at line 63 of file array.hpp.


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


uavcan_communicator
Author(s):
autogenerated on Fri Dec 13 2024 03:10:05