pyfaust.demo Namespace Reference

The pyfaust demo module. More...

Classes
class	bsl
	Brain Source Localization demo. More...
class	fft
	FFT multiplication runtime comparison between DFT matrix-vector and Faust(FFT)-vector. More...
class	hadamard
	The demo for the hierarchical factorization of Hadamard matrices. More...
class	quickstart
	The FAuST quickstart script, a good place to look at for a first tour. More...
class	runtimecmp
	Runtime comparison demo: Faust-vector and dense matrix-vector multiplications, differents RCGs, transpose. More...

Functions
def	get_data_dirpath (silent=True)
	Returns the data directory path which varies according to the way pyfaust was installed. More...
def	runall ()
	Runs all the demos in a row. More...
def	allfigs ()
	Renders all the demo figures into files. More...

Variables
string	DEFT_RESULTS_DIR = 'pyfaust_demo_output'
	The default output directory for the demo results. More...
string	DEFT_FIG_DIR = 'pyfaust_demo_figures'
	The default figure output directory for the demos. More...

Detailed Description

The pyfaust demo module.

The run*() functions produce the results (by default in demo.DEFT_RESULTS_DIR) and the fig*() functions produce the figures based on the results (by default in demo.DEFT_FIG_DIR).

Warning

this demo module is a recent port from matlab version and should be considered in beta status.

Function Documentation

allfigs()

def pyfaust.demo.allfigs

(

)

Renders all the demo figures into files.

Note

The function must be call after runall() or after each demo run* function executed separately.

get_data_dirpath()

def pyfaust.demo.get_data_dirpath

(

silent = True

)

Returns the data directory path which varies according to the way pyfaust was installed.

runall()

def pyfaust.demo.runall

(

)

Runs all the demos in a row.

Example

>>> from pyfaust.demo import runall, allfigs
>>> runall() # doctest:+ELLIPSIS

***...

>>> # benchmark data files go in DEFT_RESULTS_DIR
>>> allfigs() # doctest:+ELLIPSIS

***...

>>> # figures resulting from benchmark go in DEFT_FIG_DIR

Variable Documentation

DEFT_FIG_DIR

string pyfaust.demo.DEFT_FIG_DIR = 'pyfaust_demo_figures'

The default figure output directory for the demos.

DEFT_RESULTS_DIR

string pyfaust.demo.DEFT_RESULTS_DIR = 'pyfaust_demo_output'

The default output directory for the demo results.