num::GivensRotation Struct Reference

#include <small_matrix.hpp>

Public Member Functions
constexpr void	apply (real &x, real &y) const noexcept
constexpr void	apply_t (real &x, real &y) const noexcept
constexpr SmallMatrix< 2, 2 >	matrix () const noexcept

Static Public Member Functions
static constexpr GivensRotation	from (real a, real b) noexcept
	Construct \(G=\begin{bmatrix}c&s\\-s&c\end{bmatrix}\).

Public Attributes
real	c = 1
real	s = 0

Detailed Description

Definition at line 135 of file small_matrix.hpp.

Member Function Documentation

apply()

constexpr void num::GivensRotation::apply ( real &  x, real &  y  ) const

inlineconstexprnoexcept

Definition at line 148 of file small_matrix.hpp.

References c, and s.

apply_t()

constexpr void num::GivensRotation::apply_t ( real &  x, real &  y  ) const

inlineconstexprnoexcept

Definition at line 154 of file small_matrix.hpp.

References c, and s.

from()

static constexpr GivensRotation num::GivensRotation::from ( real  a, real  b  )

inlinestaticconstexprnoexcept

Construct \(G=\begin{bmatrix}c&s\\-s&c\end{bmatrix}\).

Definition at line 140 of file small_matrix.hpp.

matrix()

constexpr SmallMatrix< 2, 2 > num::GivensRotation::matrix ( ) const

inlineconstexprnoexcept

Definition at line 160 of file small_matrix.hpp.

References c, and s.

Member Data Documentation

c

real num::GivensRotation::c = 1

Definition at line 136 of file small_matrix.hpp.

Referenced by apply(), apply_t(), and matrix().

s

real num::GivensRotation::s = 0

Definition at line 137 of file small_matrix.hpp.

Referenced by apply(), apply_t(), and matrix().

---

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

• /home/runner/work/numerics/numerics/include/core/small_matrix.hpp