Illustrated C/C++ source sheets, symbol index, API relationship graph, compiler console and debug trace

LIVE AI / FLEXIBLE SENSING / FLIGHT CONTEXT

Sensoraia API

Live AI and sensing, connected to the flight.
See, listen, inspect and return supported results while airborne.

Loading...
Searching...
No Matches
Aigen::Matrix Class Reference

aigenlib storage with the planner's signed dimensions and finite predicate. More...

#include <compat.hpp>

Inheritance diagram for Aigen::Matrix:
Collaboration diagram for Aigen::Matrix:

Public Member Functions

 Matrix (dipla::aigenlib::Matrix value)
 Accept an owning kernel result.
int rows () const noexcept
 Signed row count.
int cols () const noexcept
 Signed column count.
int size () const noexcept
 Signed scalar count.
bool allFinite () const noexcept
 Test every scalar.
 Matrix ()=default
 Construct an empty matrix.
 Matrix (std::size_t rows, std::size_t columns, double value=0.0)
 Allocate initialized storage.
 Matrix (const Matrix &other)=default
 Deep copy.
 Matrix (Matrix &&other) noexcept
 Transfer storage.
Public Member Functions inherited from dipla::aigenlib::Matrix
 Matrix ()=default
 Construct an empty matrix.
 Matrix (std::size_t rows, std::size_t columns, double value=0.0)
 Allocate initialized storage.
 Matrix (const Matrix &other)=default
 Deep copy.
Matrix & operator= (const Matrix &other)
 Deep assignment with strong exception guarantee.
 Matrix (Matrix &&other) noexcept
 Transfer storage.
Matrix & operator= (Matrix &&other) noexcept
 Transfer storage.
std::size_t rows () const noexcept
 Row count.
std::size_t cols () const noexcept
 Column count.
std::size_t size () const noexcept
 Allocated scalar count.
double & operator() (std::size_t row, std::size_t column)
 Checked access.
double operator() (std::size_t row, std::size_t column) const
 Checked access.
double * row_data (std::size_t row)
 Borrow a row.
const double * row_data (std::size_t row) const
 Borrow a row.
bool finite () const noexcept
 Validate all stored scalars.
double trace () const
 Sum a square matrix's diagonal.

Static Public Member Functions

static Matrix Zero (std::size_t rows, std::size_t columns)
 Allocate zero storage.

Detailed Description

aigenlib storage with the planner's signed dimensions and finite predicate.

Public inheritance permits zero-copy calls into aigenlib kernels.

Definition at line 51 of file compat.hpp.

Constructor & Destructor Documentation

◆ Matrix() [1/5]

Aigen::Matrix::Matrix ( dipla::aigenlib::Matrix value)
inline

Accept an owning kernel result.

Parameters
valueMatrix storage.

Definition at line 55 of file compat.hpp.

◆ Matrix() [2/5]

Construct an empty matrix.

◆ Matrix() [3/5]

dipla::aigenlib::Matrix::Matrix ( std::size_t rows,
std::size_t columns,
double value = 0.0 )

Allocate initialized storage.

Parameters
rowsRow count.
columnsColumn count.
valueInitial scalar.

Definition at line 100 of file aigenlib.cpp.

◆ Matrix() [4/5]

dipla::aigenlib::Matrix::Matrix ( const Matrix & other)
default

Deep copy.

Parameters
otherSource.

◆ Matrix() [5/5]

dipla::aigenlib::Matrix::Matrix ( Matrix && other)
noexcept

Transfer storage.

Parameters
otherSource, emptied afterwards.

Definition at line 106 of file aigenlib.cpp.

Member Function Documentation

◆ allFinite()

bool Aigen::Matrix::allFinite ( ) const
inlinenoexcept

Test every scalar.

Returns
Whether finite.

Definition at line 63 of file compat.hpp.

◆ cols()

int Aigen::Matrix::cols ( ) const
inlinenoexcept

Signed column count.

Returns
Bounded columns.

Definition at line 59 of file compat.hpp.

◆ rows()

int Aigen::Matrix::rows ( ) const
inlinenoexcept

Signed row count.

Returns
Bounded rows.

Definition at line 57 of file compat.hpp.

◆ size()

int Aigen::Matrix::size ( ) const
inlinenoexcept

Signed scalar count.

Returns
Bounded scalar count.

Definition at line 61 of file compat.hpp.

◆ Zero()

Matrix Aigen::Matrix::Zero ( std::size_t rows,
std::size_t columns )
inlinestatic

Allocate zero storage.

Parameters
rowsRows.
columnsColumns.
Returns
Zero matrix.

Definition at line 65 of file compat.hpp.


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