GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
fftw_planner Class Reference

#include "oct-fftw.h"

Public Types

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

Public Member Functions

 ~fftw_planner ()
 

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 double *in, Complex *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 Complex *in, Complex *out)
 
static bool instance_ok ()
 
static FftwMethod method ()
 
static FftwMethod method (FftwMethod meth)
 
static int threads ()
 
static void threads (int nt)
 

Protected Member Functions

 fftw_planner ()
 

Detailed Description

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

Member Enumeration Documentation

◆ FftwMethod

enum fftw_planner::FftwMethod
Enumerator
UNKNOWN 
ESTIMATE 
MEASURE 
PATIENT 
EXHAUSTIVE 
HYBRID 

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

Constructor & Destructor Documentation

◆ fftw_planner()

fftw_planner::fftw_planner ( )
protected

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

References OCTAVE_NPROC_CURRENT_OVERRIDABLE, and octave_num_processors_wrapper().

Referenced by instance_ok().

◆ ~fftw_planner()

fftw_planner::~fftw_planner ( )

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

Member Function Documentation

◆ create_plan() [1/2]

static void* fftw_planner::create_plan ( const int  rank,
const dim_vector &  dims,
octave_idx_type  howmany,
octave_idx_type  stride,
octave_idx_type  dist,
const double *  in,
Complex *  out 
)
inlinestatic

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

◆ create_plan() [2/2]

static void* 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 Complex *  in,
Complex *  out 
)
inlinestatic

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

Referenced by fftw::fft(), fftw::fftNd(), fftw::ifft(), and fftw::ifftNd().

◆ instance_ok()

bool fftw_planner::instance_ok ( )
static

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

References fftw_planner(), and singleton_cleanup_list::add().

Referenced by threads().

◆ method() [1/2]

static FftwMethod fftw_planner::method ( )
inlinestatic

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

Referenced by Ffftw().

◆ method() [2/2]

static FftwMethod fftw_planner::method ( FftwMethod  meth)
inlinestatic

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

◆ threads() [1/2]

static int fftw_planner::threads ( )
inlinestatic

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

Referenced by Ffftw(), and threads().

◆ threads() [2/2]

void fftw_planner::threads ( int  nt)
static

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

References instance_ok(), and threads().

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