MostlyHarmless 0.0.1
 
Loading...
Searching...
No Matches
marvin::math::Householder< SampleType, size > Class Template Reference

A helper class to apply an NxN Householder matrix to a given input array-like. More...

#include <marvin_MixMatrix.h>

Static Public Member Functions

static void inPlace (SampleType *arr)
 

Detailed Description

template<FloatType SampleType, int size>
requires (size >= 1)
class marvin::math::Householder< SampleType, size >

A helper class to apply an NxN Householder matrix to a given input array-like.

size must be greater than or equal to 1. Example usage:

std::array<float, 4> arr{ 1, 0, 0, 0 };
marvin::utils::Householder<float, 4>::inPlace(arr.data());

Member Function Documentation

◆ inPlace()

template<FloatType SampleType, int size>
static void marvin::math::Householder< SampleType, size >::inPlace ( SampleType * arr)
inlinestatic

Multiplies a given input of size by a size x size Householder matrix.

Parameters
arrA pointer to the internal data of an array-like to apply the Householder matrix to.

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