Loading...
Searching...
No Matches
Bounded owning vector with the planner's small Eigen-style value API.
More...
#include <compat.hpp>
|
| | Vector (std::size_t count=0, double value=0.0) |
| | Allocate initialized scalars.
|
| | Vector (dipla::aigenlib::Vector values) |
| | Accept owning kernel output.
|
| int | size () const noexcept |
| | Signed vector length.
|
| int | rows () const noexcept |
| | Matrix-compatible row count.
|
| int | cols () const noexcept |
| | Matrix-compatible column count.
|
| double | operator() (std::size_t row, std::size_t column) const |
| | Checked matrix-style access.
|
| Vector | eval () const |
| | Produce a value, never an expression.
|
| bool | allFinite () const |
| | Validate every scalar.
|
| double | sum () const |
| | Sum all entries.
|
| double | norm () const |
| | Stable Euclidean length.
|
| Vector & | operator+= (const Vector &other) |
| | Add a same-sized vector.
|
| bool | isApprox (const Vector &other, double tolerance) const |
| | Relative norm comparison.
|
Bounded owning vector with the planner's small Eigen-style value API.
No expression objects or implicit unbounded allocations are exposed.
Definition at line 72 of file compat.hpp.
◆ Vector() [1/2]
| Aigen::Vector::Vector |
( |
std::size_t | count = 0, |
|
|
double | value = 0.0 ) |
|
inlineexplicit |
Allocate initialized scalars.
- Parameters
-
| count | Length. |
| value | Initial scalar. |
Definition at line 75 of file compat.hpp.
◆ Vector() [2/2]
Accept owning kernel output.
- Parameters
-
Definition at line 78 of file compat.hpp.
◆ allFinite()
| bool Aigen::Vector::allFinite |
( |
| ) |
const |
|
inline |
Validate every scalar.
- Returns
- Whether finite.
Definition at line 97 of file compat.hpp.
◆ checked_size()
| std::size_t Aigen::Vector::checked_size |
( |
std::size_t | count | ) |
|
|
inlinestaticprivate |
Validate before allocating.
- Parameters
-
- Returns
- Checked length.
Definition at line 123 of file compat.hpp.
◆ cols()
| int Aigen::Vector::cols |
( |
| ) |
const |
|
inlinenoexcept |
Matrix-compatible column count.
- Returns
- One.
Definition at line 84 of file compat.hpp.
◆ Constant()
| Vector Aigen::Vector::Constant |
( |
std::size_t | count, |
|
|
double | value ) |
|
inlinestatic |
Allocate a constant.
- Parameters
-
| count | Length. |
| value | Scalar. |
- Returns
- Owning vector.
Definition at line 93 of file compat.hpp.
◆ eval()
| Vector Aigen::Vector::eval |
( |
| ) |
const |
|
inline |
Produce a value, never an expression.
- Returns
- Owning copy.
Definition at line 95 of file compat.hpp.
◆ isApprox()
| bool Aigen::Vector::isApprox |
( |
const Vector & | other, |
|
|
double | tolerance ) const |
|
inline |
Relative norm comparison.
- Parameters
-
| other | Vector. |
| tolerance | Relative limit. |
- Returns
- Whether approximately equal.
Definition at line 115 of file compat.hpp.
◆ norm()
| double Aigen::Vector::norm |
( |
| ) |
const |
|
inline |
Stable Euclidean length.
- Returns
- Norm.
Definition at line 103 of file compat.hpp.
◆ operator()()
| double Aigen::Vector::operator() |
( |
std::size_t | row, |
|
|
std::size_t | column ) const |
|
inline |
Checked matrix-style access.
- Parameters
-
| row | Row. |
| column | Must be zero. |
- Returns
- Scalar.
Definition at line 86 of file compat.hpp.
◆ operator+=()
Add a same-sized vector.
- Parameters
-
- Returns
- This vector.
Definition at line 109 of file compat.hpp.
◆ rows()
| int Aigen::Vector::rows |
( |
| ) |
const |
|
inlinenoexcept |
Matrix-compatible row count.
- Returns
- Length.
Definition at line 82 of file compat.hpp.
◆ size()
| int Aigen::Vector::size |
( |
| ) |
const |
|
inlinenoexcept |
Signed vector length.
- Returns
- Bounded length.
Definition at line 80 of file compat.hpp.
◆ sum()
| double Aigen::Vector::sum |
( |
| ) |
const |
|
inline |
Sum all entries.
- Returns
- Sum.
Definition at line 101 of file compat.hpp.
◆ Zero()
| Vector Aigen::Vector::Zero |
( |
std::size_t | count | ) |
|
|
inlinestatic |
Allocate zeros.
- Parameters
-
- Returns
- Owning vector.
Definition at line 91 of file compat.hpp.
The documentation for this class was generated from the following file: