Audacity 3.2.0
Public Member Functions | List of all members
PffftFloatVector Struct Reference

A vector of floats guaranteeing alignment as demanded by pffft. More...

#include <PowerSpectrumGetter.h>

Inheritance diagram for PffftFloatVector:
[legend]
Collaboration diagram for PffftFloatVector:
[legend]

Public Member Functions

PffftFloats aligned (PffftAlignedCount c={})
 
PffftConstFloats aligned (PffftAlignedCount c={}) const
 
PffftFloats aligned (PffftAlignedCount rowSize, size_t nRow)
 
PffftConstFloats aligned (PffftAlignedCount rowSize, size_t nRow) const
 

Detailed Description

A vector of floats guaranteeing alignment as demanded by pffft.

It also exposes aligned which returns pointers to aligned sub-ranges only

Usual hazards of pointer invalidation or out-of-bounds subscripting still apply.

Size and capacity are NOT constrained to be aligned.

Definition at line 184 of file PowerSpectrumGetter.h.

Member Function Documentation

◆ aligned() [1/4]

PffftFloats PffftFloatVector::aligned ( PffftAlignedCount  c = {})
Returns
data() + c

Definition at line 31 of file PowerSpectrumGetter.cpp.

32{
33 return PffftFloats{ data() + c };
34}
A pointer to an aligned range of floats.

Referenced by MIR::GetOnsetDetectionFunction().

Here is the caller graph for this function:

◆ aligned() [2/4]

PffftConstFloats PffftFloatVector::aligned ( PffftAlignedCount  c = {}) const
Returns
data() + c

Definition at line 36 of file PowerSpectrumGetter.cpp.

37{
38 return PffftConstFloats{ data() + c };
39}
A read-only pointer to an aligned range of floats.

◆ aligned() [3/4]

PffftFloats PffftFloatVector::aligned ( PffftAlignedCount  rowSize,
size_t  nRow 
)
inline

Two-argument overload views the contiguous vector as multiple aligned rows

Definition at line 193 of file PowerSpectrumGetter.h.

194 { return aligned(rowSize * nRow); }
PffftFloats aligned(PffftAlignedCount c={})

◆ aligned() [4/4]

PffftConstFloats PffftFloatVector::aligned ( PffftAlignedCount  rowSize,
size_t  nRow 
) const
inline

Two-argument overload views the contiguous vector as multiple aligned rows

Definition at line 198 of file PowerSpectrumGetter.h.

199 { return aligned(rowSize * nRow); }

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