GNU Octave  6.2.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
octave::float_fftw_planner Class Reference

#include "oct-fftw.h"

Collaboration diagram for octave::float_fftw_planner:

Public Types

enum  FftwMethod {
  UNKNOWN = -1 , ESTIMATE , MEASURE , PATIENT ,
  EXHAUSTIVE , HYBRID
}
 

Public Member Functions

 float_fftw_planner (const float_fftw_planner &)=delete
 
 ~float_fftw_planner (void)
 
float_fftw_planneroperator= (const float_fftw_planner &)=delete
 

Static Public Member Functions

static void * create_plan (const int rank, const dim_vector &dims, octave_idx_type howmany, octave_idx_type stride, octave_idx_type dist, const float *in, FloatComplex *out)
 
static void * create_plan (int dir, const int rank, const dim_vector &dims, octave_idx_type howmany, octave_idx_type stride, octave_idx_type dist, const FloatComplex *in, FloatComplex *out)
 
static bool instance_ok (void)
 
static FftwMethod method (FftwMethod _meth)
 
static FftwMethod method (void)
 
static void threads (int nt)
 
static int threads (void)
 

Protected Member Functions

 float_fftw_planner (void)
 

Private Member Functions

void * do_create_plan (const int rank, const dim_vector &dims, octave_idx_type howmany, octave_idx_type stride, octave_idx_type dist, const float *in, FloatComplex *out)
 
void * do_create_plan (int dir, const int rank, const dim_vector &dims, octave_idx_type howmany, octave_idx_type stride, octave_idx_type dist, const FloatComplex *in, FloatComplex *out)
 
FftwMethod do_method (FftwMethod _meth)
 
FftwMethod do_method (void)
 

Static Private Member Functions

static void cleanup_instance (void)
 

Private Attributes

octave_idx_type d [2]
 
octave_idx_type h [2]
 
bool inplace [2]
 
FftwMethod meth
 
dim_vector n [2]
 
int nthreads
 
void * plan [2]
 
int r [2]
 
octave_idx_type rd
 
octave_idx_type rh
 
dim_vector rn
 
void * rplan
 
int rr
 
octave_idx_type rs
 
bool rsimd_align
 
octave_idx_type s [2]
 
bool simd_align [2]
 

Static Private Attributes

static float_fftw_plannerinstance = nullptr
 

Detailed Description

Definition at line 185 of file oct-fftw.h.

Member Enumeration Documentation

◆ FftwMethod

Enumerator
UNKNOWN 
ESTIMATE 
MEASURE 
PATIENT 
EXHAUSTIVE 
HYBRID 

Definition at line 204 of file oct-fftw.h.

Constructor & Destructor Documentation

◆ float_fftw_planner() [1/2]

octave::float_fftw_planner::float_fftw_planner ( void  )
protected

Definition at line 422 of file oct-fftw.cc.

References d, h, inplace, n, nthreads, OCTAVE_NPROC_CURRENT_OVERRIDABLE, octave_num_processors_wrapper(), plan, r, s, and simd_align.

Referenced by instance_ok().

◆ float_fftw_planner() [2/2]

octave::float_fftw_planner::float_fftw_planner ( const float_fftw_planner )
delete

◆ ~float_fftw_planner()

octave::float_fftw_planner::~float_fftw_planner ( void  )

Definition at line 447 of file oct-fftw.cc.

References plan, and rplan.

Member Function Documentation

◆ cleanup_instance()

static void octave::float_fftw_planner::cleanup_instance ( void  )
inlinestaticprivate

Definition at line 264 of file oct-fftw.h.

Referenced by instance_ok().

◆ create_plan() [1/2]

static void* octave::float_fftw_planner::create_plan ( const int  rank,
const dim_vector dims,
octave_idx_type  howmany,
octave_idx_type  stride,
octave_idx_type  dist,
const float *  in,
FloatComplex out 
)
inlinestatic

Definition at line 229 of file oct-fftw.h.

◆ create_plan() [2/2]

static void* octave::float_fftw_planner::create_plan ( int  dir,
const int  rank,
const dim_vector dims,
octave_idx_type  howmany,
octave_idx_type  stride,
octave_idx_type  dist,
const FloatComplex in,
FloatComplex out 
)
inlinestatic

◆ do_create_plan() [1/2]

void * octave::float_fftw_planner::do_create_plan ( const int  rank,
const dim_vector dims,
octave_idx_type  howmany,
octave_idx_type  stride,
octave_idx_type  dist,
const float *  in,
FloatComplex out 
)
private

◆ do_create_plan() [2/2]

void * octave::float_fftw_planner::do_create_plan ( int  dir,
const int  rank,
const dim_vector dims,
octave_idx_type  howmany,
octave_idx_type  stride,
octave_idx_type  dist,
const FloatComplex in,
FloatComplex out 
)
private

◆ do_method() [1/2]

float_fftw_planner::FftwMethod octave::float_fftw_planner::do_method ( FftwMethod  _meth)
private

Definition at line 748 of file oct-fftw.cc.

References ESTIMATE, EXHAUSTIVE, HYBRID, MEASURE, meth, PATIENT, plan, rplan, and UNKNOWN.

◆ do_method() [2/2]

float_fftw_planner::FftwMethod octave::float_fftw_planner::do_method ( void  )
private

Definition at line 742 of file oct-fftw.cc.

References meth.

◆ instance_ok()

bool octave::float_fftw_planner::instance_ok ( void  )
static

Definition at line 465 of file oct-fftw.cc.

References float_fftw_planner(), singleton_cleanup_list::add(), cleanup_instance(), instance, and retval.

Referenced by threads().

◆ method() [1/2]

static FftwMethod octave::float_fftw_planner::method ( FftwMethod  _meth)
inlinestatic

Definition at line 246 of file oct-fftw.h.

◆ method() [2/2]

static FftwMethod octave::float_fftw_planner::method ( void  )
inlinestatic

Definition at line 239 of file oct-fftw.h.

Referenced by Ffftw().

◆ operator=()

float_fftw_planner& octave::float_fftw_planner::operator= ( const float_fftw_planner )
delete

◆ threads() [1/2]

void octave::float_fftw_planner::threads ( int  nt)
static

Definition at line 479 of file oct-fftw.cc.

References instance, instance_ok(), nthreads, plan, rplan, and threads().

◆ threads() [2/2]

static int octave::float_fftw_planner::threads ( void  )
inlinestatic

Definition at line 255 of file oct-fftw.h.

Referenced by Ffftw(), and threads().

Member Data Documentation

◆ d

octave_idx_type octave::float_fftw_planner::d[2]
private

Definition at line 289 of file oct-fftw.h.

Referenced by float_fftw_planner(), and do_create_plan().

◆ h

octave_idx_type octave::float_fftw_planner::h[2]
private

Definition at line 298 of file oct-fftw.h.

Referenced by float_fftw_planner(), and do_create_plan().

◆ inplace

bool octave::float_fftw_planner::inplace[2]
private

Definition at line 304 of file oct-fftw.h.

Referenced by float_fftw_planner(), and do_create_plan().

◆ instance

float_fftw_planner * octave::float_fftw_planner::instance = nullptr
staticprivate

Definition at line 262 of file oct-fftw.h.

Referenced by instance_ok(), and threads().

◆ meth

FftwMethod octave::float_fftw_planner::meth
private

Definition at line 281 of file oct-fftw.h.

Referenced by do_create_plan(), and do_method().

◆ n

dim_vector octave::float_fftw_planner::n[2]
private

Definition at line 301 of file oct-fftw.h.

Referenced by float_fftw_planner(), and do_create_plan().

◆ nthreads

int octave::float_fftw_planner::nthreads
private

Definition at line 328 of file oct-fftw.h.

Referenced by float_fftw_planner(), and threads().

◆ plan

void* octave::float_fftw_planner::plan[2]
private

◆ r

int octave::float_fftw_planner::r[2]
private

Definition at line 295 of file oct-fftw.h.

Referenced by float_fftw_planner(), and do_create_plan().

◆ rd

octave_idx_type octave::float_fftw_planner::rd
private

Definition at line 310 of file oct-fftw.h.

Referenced by do_create_plan().

◆ rh

octave_idx_type octave::float_fftw_planner::rh
private

Definition at line 319 of file oct-fftw.h.

Referenced by do_create_plan().

◆ rn

dim_vector octave::float_fftw_planner::rn
private

Definition at line 322 of file oct-fftw.h.

Referenced by do_create_plan().

◆ rplan

void* octave::float_fftw_planner::rplan
private

Definition at line 307 of file oct-fftw.h.

Referenced by ~float_fftw_planner(), do_create_plan(), do_method(), and threads().

◆ rr

int octave::float_fftw_planner::rr
private

Definition at line 316 of file oct-fftw.h.

Referenced by do_create_plan().

◆ rs

octave_idx_type octave::float_fftw_planner::rs
private

Definition at line 313 of file oct-fftw.h.

Referenced by do_create_plan().

◆ rsimd_align

bool octave::float_fftw_planner::rsimd_align
private

Definition at line 324 of file oct-fftw.h.

Referenced by do_create_plan().

◆ s

octave_idx_type octave::float_fftw_planner::s[2]
private

Definition at line 292 of file oct-fftw.h.

Referenced by float_fftw_planner(), and do_create_plan().

◆ simd_align

bool octave::float_fftw_planner::simd_align[2]
private

Definition at line 303 of file oct-fftw.h.

Referenced by float_fftw_planner(), and do_create_plan().


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