akreon-linalg
Fixed-size linear algebra and numerical methods in C++26.
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
linalg::L2< Vec > Struct Template Reference

forward declaration for L2 norm More...

#include <vector_norms.hpp>

Public Types

using domain_type = remove_cvref_t< Vec >
 
using scalar_type = vector_element_t< domain_type >
 
using codomain_type = real_type_t< scalar_type >
 

Public Member Functions

constexpr codomain_type operator() (const domain_type &x) const
 

Detailed Description

template<FieldVector Vec>
struct linalg::L2< Vec >

forward declaration for L2 norm

compute the L2 norm of a vector

|| X ||_2 or sqrt(X^T X)

Parameters
vectorX with N elements of type T
Returns
scalar

Definition at line 24 of file vector_norms.hpp.

Member Typedef Documentation

◆ codomain_type

template<FieldVector Vec>
using linalg::L2< Vec >::codomain_type = real_type_t<scalar_type>

Definition at line 27 of file vector_norms.hpp.

◆ domain_type

template<FieldVector Vec>
using linalg::L2< Vec >::domain_type = remove_cvref_t<Vec>

Definition at line 25 of file vector_norms.hpp.

◆ scalar_type

template<FieldVector Vec>
using linalg::L2< Vec >::scalar_type = vector_element_t<domain_type>

Definition at line 26 of file vector_norms.hpp.

Member Function Documentation

◆ operator()()

template<FieldVector Vec>
constexpr codomain_type linalg::L2< Vec >::operator() ( const domain_type &  x) const
inlineconstexpr

Definition at line 29 of file vector_norms.hpp.

References AK_ASSERT, linalg::constexpr_sqrt_safe(), linalg::inner_product(), linalg::is_real(), and linalg::mat_rows_v.

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