Waveform memory allocation

---

Detailed Description

bpm_defs.h

Main definitions for libbpm as well as doxygen intro documentation

These are a number of definitions to make the code run on various systems ( like e.g. win32... ) and some other general definitions used by the library.

Files
file	alloc_complex_wave_double.c
file	alloc_simple_wave_double.c
file	alloc_simple_wave_int.c
file	bpm_alloc.h
	libbpm waveform memory allocation routines
Functions
EXTERN double **	alloc_complex_wave_double (int ns)
EXTERN void	free_complex_wave_double (double **w, int ns)
EXTERN double *	alloc_simple_wave_double (int ns)
EXTERN void	free_simple_wave_double (double *w)
EXTERN int *	alloc_simple_wave_int (int ns)
EXTERN void	free_simple_wave_int (int *w)

---

Function Documentation

EXTERN double** alloc_complex_wave_double

(

int

ns

)

Allocates memory for a complex waveform of doubles. A pointer is returned to the reserved memory. Use free_complex_wave_double( w, ns ) to free up the memory.

Parameters:

ns

Number of samples

Returns:

a pointer to the reserved memory

Definition at line 8 of file alloc_complex_wave_double.c.

References bpm_error().

Referenced by ddc_sample_waveform(), ddc_waveform(), generate_diode(), generate_dipole(), and generate_monopole().

EXTERN void free_complex_wave_double	(	double **	w,
		int	ns
	)

Frees up the memory reserved by alloc_complex_wave_double( ns ).

Parameters:

	w	A pointer to a complex waveform of doubles
	ns	Number of samples

Returns:

void

Definition at line 34 of file alloc_complex_wave_double.c.

Referenced by ddc_sample_waveform(), ddc_waveform(), generate_diode(), generate_dipole(), and generate_monopole().

EXTERN double* alloc_simple_wave_double

(

int

ns

)

Allocates memory for a simple waveform of doubles. A pointer is returned to the reserved memory. Use free_simple_wave_double( w ) to free up the memory.

Parameters:

ns

Number of samples

Returns:

a pointer to the reserved memory

Definition at line 9 of file alloc_simple_wave_double.c.

References bpm_error().

Referenced by create_filter(), ddc_waveform(), fit_fft(), fit_waveform(), generate_dipole(), and generate_monopole().

EXTERN void free_simple_wave_double

(

double *

w

)

Frees up the memory reserved by alloc_simple_wave_double( ns ).

Parameters:

w

A pointer to a complex waveform of doubles

Returns:

void

Definition at line 27 of file alloc_simple_wave_double.c.

Referenced by ddc_waveform(), delete_filter(), fit_fft(), fit_waveform(), generate_dipole(), and generate_monopole().

EXTERN int* alloc_simple_wave_int

(

int

ns

)

Allocates memory for a simple waveform of integers. A pointer is returned to the reserved memory. Use free_simple_wave_int( w ) to free up the memory.

Parameters:

ns

Number of samples

Returns:

a pointer to the reserved memory

Definition at line 9 of file alloc_simple_wave_int.c.

References bpm_error().

Referenced by generate_diode(), generate_dipole(), and generate_monopole().

EXTERN void free_simple_wave_int

(

int *

w

)

Frees up the memory reserved by alloc_simple_wave_int( ns ).

Parameters:

w

A pointer to a complex waveform of integers

Returns:

void

Definition at line 26 of file alloc_simple_wave_int.c.

---