IDS peak ICV v1.3.0
Loading...
Searching...
No Matches
TransformationMatrix3D Class Reference

#include <peak_icv/types/peak_icv_transformation_matrix_3d.hpp>

Inheritance diagram for TransformationMatrix3D:

Public Member Functions

constexpr const float * GetData () const
 Returns a pointer to the underlying data of the array.
 
constexpr float & At (std::size_t row, std::size_t col)
 Accesses the element at the specified row and column.
 
constexpr const float & At (std::size_t row, std::size_t col) const
 Accesses the element at the specified row and column (const version).
 
constexpr std::size_t GetNumberOfRows () const
 Gets the number of rows in the array.
 
constexpr std::size_t GetNumberOfColumns () const
 Gets the number of columns in the array.
 
auto begin ()
 Returns an iterator to the beginning of the array.
 
auto cbegin () const
 Returns a const iterator to the beginning of the array.
 
auto end ()
 Returns an iterator to the end of the array.
 
auto cend () const
 Returns a const iterator to the end of the array.
 

Static Public Member Functions

static Matrix Identity ()
 Creates and returns an identity matrix.
 
static Matrix Diagonal (const float &value)
 Constructs a uniform diagonal matrix.
 

Detailed Description

A transformation matrix is a square matrix that, when multiplied by the coordinates of a geometric object, changes the position, orientation, or size of the object.

Since
ids_peak_icv 1.1

Definition at line 28 of file peak_icv_transformation_matrix_3d.hpp.

Member Function Documentation

◆ At() [1/2]

float & At ( std::size_t row,
std::size_t col )
inlineconstexprinherited

Accesses the element at the specified row and column.

This method throws an exception if the indices are out of range.

Parameters
rowThe row index of the element to access.
colThe column index of the element to access.
Returns
A reference to the element at the specified indices.
Exceptions
OutOfRangeExceptionIf the row or column index is out of range.
Since
ids_peak_icv 1.0

Definition at line 103 of file peak_icv_array_2d.hpp.

◆ At() [2/2]

const float & At ( std::size_t row,
std::size_t col ) const
inlineconstexprinherited

Accesses the element at the specified row and column (const version).

This method throws an exception if the indices are out of range.

Parameters
rowThe row index of the element to access.
colThe column index of the element to access.
Returns
A const reference to the element at the specified indices.
Exceptions
OutOfRangeExceptionIf the row or column index is out of range.
Since
ids_peak_icv 1.0

Definition at line 126 of file peak_icv_array_2d.hpp.

◆ begin()

auto begin ( )
inherited

Returns an iterator to the beginning of the array.

Returns
An iterator pointing to the first element of the array.
Since
ids_peak_icv 1.0

Definition at line 166 of file peak_icv_array_2d.hpp.

◆ cbegin()

auto cbegin ( ) const
inherited

Returns a const iterator to the beginning of the array.

Returns
An iterator pointing to the first element of the array.

Definition at line 173 of file peak_icv_array_2d.hpp.

◆ cend()

auto cend ( ) const
inherited

Returns a const iterator to the end of the array.

Returns
An iterator pointing to one past the last element of the array.

Definition at line 189 of file peak_icv_array_2d.hpp.

◆ Diagonal()

static Matrix Diagonal ( const float & value)
inlinestaticinherited

Constructs a uniform diagonal matrix.

Parameters
valueThe scalar value to be placed along the diagonal.
Returns
A Matrix with value on the diagonal and zeros elsewhere.
Since
ids_peak_icv 1.0

Definition at line 58 of file peak_icv_matrix.hpp.

◆ end()

auto end ( )
inherited

Returns an iterator to the end of the array.

Returns
An iterator pointing to one past the last element of the array.
Since
ids_peak_icv 1.0

Definition at line 182 of file peak_icv_array_2d.hpp.

◆ GetData()

const float * GetData ( ) const
inlineconstexprinherited

Returns a pointer to the underlying data of the array.

Returns
A pointer to the array data.
Since
ids_peak_icv 1.0

Definition at line 84 of file peak_icv_array_2d.hpp.

◆ GetNumberOfColumns()

std::size_t GetNumberOfColumns ( ) const
inlineconstexprinherited

Gets the number of columns in the array.

Returns
The number of columns in the array.
Since
ids_peak_icv 1.0

Definition at line 154 of file peak_icv_array_2d.hpp.

◆ GetNumberOfRows()

std::size_t GetNumberOfRows ( ) const
inlineconstexprinherited

Gets the number of rows in the array.

Returns
The number of rows in the array.
Since
ids_peak_icv 1.0

Definition at line 142 of file peak_icv_array_2d.hpp.

◆ Identity()

static Matrix Identity ( )
inlinestaticinherited

Creates and returns an identity matrix.

Since
ids_peak_icv 1.0

Definition at line 44 of file peak_icv_matrix.hpp.