libdspl-2.0 Digital Signal Processing Algorithm Library
Error codes.

## Macros

#define RES_OK   0
The function completed correctly. No errors. More...

#define ERROR_ARG_PARAM   0x01180716
Invalid program call parameter. This error occurs when a program is called with an invalid the number of arguments argc and the pointerargv to an array of program call parameters. More...

#define ERROR_DAT_TYPE   0x04012020
Invalid data type. This error occurs when saving data to a binary file, when the parameter the defining data type in memory (real or complex) is set incorrectly. More...

#define ERROR_DIV_ZERO   0x04102226
Division by zero error. The function returns this error if a computational algorithm occurs division by zero. More...

#define ERROR_ELLIP_MODULE   0x05121315
The modulus of the Jacobi elliptic integral must be from 0 to 1. This error occurs when calculating Jacobi elliptic functions if the parameter of the elliptic module is incorrectly set. The function exits and returns the given error code. More...

#define ERROR_FFT_SIZE   0x06062021
The FFT size is not set correctly. FFT size can be composite $$n = n_0 \times n_1 \times n_2 \ldots \times n_p \times m$$, where $$n_i = 2,3,5,7$$, and $$m$$ – an arbitrary prime factor not exceeding 46340. An error occurs when the factor $$m$$ exceeds 46340 . More...

#define ERROR_FILTER_A0   0x06090100
Parameter $$a_0$$ cannot be zero digital for IIR filter transfer characteristic $$H (z)$$. More...

#define ERROR_FILTER_APPROX   0x06090116
Unknown approximation type of digital or analog filter. This error occurs when masks such as a digital IIR filter are incorrectly set. The library supports the following approximations: Butterworth, Chebyshev of the first kind, Chebyshev of the second kind and elliptic. More...

#define ERROR_FILTER_FT   0x06090620
The conversion frequencies of the low-pass filter and low-pass filter are incorrect. Frequency masks for bandpass and bandstop filters have two cutoff frequencies or barrage frequencies. When implementing frequency filter conversions, it is necessary to set the left cutoff frequency less than the right. More...

#define ERROR_FILTER_ORD   0x06091518
The filter order is incorrect. The order of the filter must be specified by a positive integer value. More...

#define ERROR_FILTER_ORD_BP   0x06091519
The order of the bandpass or notch filter is not set correctly. The order of the bandpass and notch filter must be given an even positive value. More...

#define ERROR_FILTER_RP   0x06091816
The filter non-uniformity parameter in the passband is set incorrectly. This parameter is specified in dB and must be a positive number. More...

#define ERROR_FILTER_RS   0x06091819
The filter suppression parameter in the boom bar is not set correctly. This parameter is specified in dB and must be a positive number. More...

#define ERROR_FILTER_TYPE   0x06092025
Unknown filter type. The library supports the following filter types: lowpass, highpass, bandpass and bandstop. More...

#define ERROR_FILTER_WP   0x06092316
The filter cutoff frequency parameter is set incorrectly. The cutoff frequency of the filter must be positive from 0 to 1 for the digital FIR filter. More...

#define ERROR_FILTER_WS   0x06092319
The filter frequency parameter is set incorrectly. The frequency must be a positive from 0 to 1. More...

#define ERROR_FNAME   0x06140113
Error in file name. You must specify the correct file name. More...

#define ERROR_FOPEN   0x06151605
Error opening file. A file with the specified name cannot be opened for writing or reading. More...

Error reading data block from binary file. An error occurs if size of the read block does not match the required value. More...

#define ERROR_FWRITE_SIZE   0x06231820
Error writing data to binary file. An error occurs if, the size of the recorded block does not match the required value. More...

#define ERROR_GNUPLOT_CREATE   0x07161203
Unable to connect to the GNUPLOT package. Please check that the package is available. More...

#define ERROR_GNUPLOT_TERM   0x07161220
Unknown program call parameter specifying the GNUPLOT terminal.
This parameter can be one of the following values:
--noplot no plotting; \ n --plotwin plot in the new window;
--plotpng plot in png file.
. More...

#define ERROR_LAPACK   0x12011601
The built-in LAPACK function returned an error code. This error is returned by the function if it uses one of the built-in LAPACK functions that failed. More...

#define ERROR_MALLOC   0x13011212
Dynamic memory allocation error. This error means that an error occurred while dynamically allocating memory. As a result, the malloc function in the body of the called function returned aNULL pointer. Further processing by the function is not possible. More...

#define ERROR_MATRIX_SIZE   0x13011926
Matrix size error. More...

#define ERROR_MIN_MAX   0x13091413
The minimum value (lower bound) is greater than the maximum. More...

#define ERROR_NEGATIVE   0x14050701
Negative parameter. The function returns the given error code when it takes a negative parameter. into a variable that cannot be negative. More...

#define ERROR_POLY_AN   0x16150114
The senior coefficient of the polynomial is incorrectly set. For example, when calculating the roots of a polynomial of degree $$N$$. More...

#define ERROR_POLY_ORD   0x16151518
The polynomial order is incorrect. The order of the polynomial must be a positive integer. More...

#define ERROR_PTR   0x16201800
Pointer error. This error means that one of the required pointers (memory to be allocated for) is transferred as NULL. When this error occurs, the function exits and returns the given error code. More...

#define ERROR_RAND_SIGMA   0x18011909
The standard deviation is incorrect normal distribution of a random variable. The standard deviation should be non-negative real number. More...

#define ERROR_RAND_TYPE   0x18012009
Unknown pseudorandom number genration algorithm. The following algorithms are used in the library: More...

#define ERROR_RESAMPLE_RATIO   0x18051801
The resampling factor is set incorrectly. The resampling factor is given by the relation $$\frac{P}{Q}$$, where $$P$$ and $$Q$$ are real positive numbers. More...

#define ERROR_RESAMPLE_FRAC_DELAY   0x18050604
Invalid fractional delay value. The fractional delay can take values from -1 to 1, where 1 corresponds to one sampling interval $$1 / F_{\textrm{s}}$$. More...

#define ERROR_SIZE   0x19092605
Error array size. This error occurs when in addition to the pointer the wrong input is passed to the input or output array size (less than or equal to zero). If this error occurs, the function exits and returns the given error code. More...

#define ERROR_SYM_TYPE   0x19251320
Parameter error of type of filling arrays in linear or logarithmic scale. Valid fill types are symmetric and periodic. More...

#define ERROR_UNWRAP   0x21142318
Error in unwrap function. The phase period and indent parameter must be positive numbers. More...

#define ERROR_WIN_PARAM   0x23091601
window function parameter error. Valid parameter values exist for each parametric window function. More...

#define ERROR_WIN_SYM   0x23091925
Symmetry or periodicity of a given window is not supported. More...

#define ERROR_WIN_TYPE   0x23092025
Unknown window function type. More...

## Detailed Description

This group describes error codes, which can be returned from DSPL-2.0 functions.

## ◆ ERROR_ARG_PARAM

 #define ERROR_ARG_PARAM   0x01180716

Invalid program call parameter. This error occurs when a program is called with an invalid the number of arguments argc and the pointerargv to an array of program call parameters.

Definition at line 562 of file dspl.h.

## ◆ ERROR_DAT_TYPE

 #define ERROR_DAT_TYPE   0x04012020

Invalid data type. This error occurs when saving data to a binary file, when the parameter the defining data type in memory (real or complex) is set incorrectly.

Definition at line 566 of file dspl.h.

## ◆ ERROR_DIV_ZERO

 #define ERROR_DIV_ZERO   0x04102226

Division by zero error. The function returns this error if a computational algorithm occurs division by zero.

Definition at line 567 of file dspl.h.

## ◆ ERROR_ELLIP_MODULE

 #define ERROR_ELLIP_MODULE   0x05121315

The modulus of the Jacobi elliptic integral must be from 0 to 1. This error occurs when calculating Jacobi elliptic functions if the parameter of the elliptic module is incorrectly set. The function exits and returns the given error code.

Definition at line 569 of file dspl.h.

## ◆ ERROR_FFT_SIZE

 #define ERROR_FFT_SIZE   0x06062021

The FFT size is not set correctly. FFT size can be composite $$n = n_0 \times n_1 \times n_2 \ldots \times n_p \times m$$, where $$n_i = 2,3,5,7$$, and $$m$$ – an arbitrary prime factor not exceeding 46340. An error occurs when the factor $$m$$ exceeds 46340 .

Definition at line 571 of file dspl.h.

## ◆ ERROR_FILTER_A0

 #define ERROR_FILTER_A0   0x06090100

Parameter $$a_0$$ cannot be zero digital for IIR filter transfer characteristic $$H (z)$$.

Definition at line 572 of file dspl.h.

## ◆ ERROR_FILTER_APPROX

 #define ERROR_FILTER_APPROX   0x06090116

Unknown approximation type of digital or analog filter. This error occurs when masks such as a digital IIR filter are incorrectly set. The library supports the following approximations: Butterworth, Chebyshev of the first kind, Chebyshev of the second kind and elliptic.

Definition at line 573 of file dspl.h.

## ◆ ERROR_FILTER_FT

 #define ERROR_FILTER_FT   0x06090620

The conversion frequencies of the low-pass filter and low-pass filter are incorrect. Frequency masks for bandpass and bandstop filters have two cutoff frequencies or barrage frequencies. When implementing frequency filter conversions, it is necessary to set the left cutoff frequency less than the right.

Definition at line 574 of file dspl.h.

## ◆ ERROR_FILTER_ORD

 #define ERROR_FILTER_ORD   0x06091518

The filter order is incorrect. The order of the filter must be specified by a positive integer value.

Definition at line 575 of file dspl.h.

## ◆ ERROR_FILTER_ORD_BP

 #define ERROR_FILTER_ORD_BP   0x06091519

The order of the bandpass or notch filter is not set correctly. The order of the bandpass and notch filter must be given an even positive value.

Definition at line 576 of file dspl.h.

## ◆ ERROR_FILTER_RP

 #define ERROR_FILTER_RP   0x06091816

The filter non-uniformity parameter in the passband is set incorrectly. This parameter is specified in dB and must be a positive number.

Definition at line 577 of file dspl.h.

## ◆ ERROR_FILTER_RS

 #define ERROR_FILTER_RS   0x06091819

The filter suppression parameter in the boom bar is not set correctly. This parameter is specified in dB and must be a positive number.

Definition at line 578 of file dspl.h.

## ◆ ERROR_FILTER_TYPE

 #define ERROR_FILTER_TYPE   0x06092025

Unknown filter type. The library supports the following filter types: lowpass, highpass, bandpass and bandstop.

Definition at line 579 of file dspl.h.

## ◆ ERROR_FILTER_WP

 #define ERROR_FILTER_WP   0x06092316

The filter cutoff frequency parameter is set incorrectly. The cutoff frequency of the filter must be positive from 0 to 1 for the digital FIR filter.

Definition at line 580 of file dspl.h.

## ◆ ERROR_FILTER_WS

 #define ERROR_FILTER_WS   0x06092319

The filter frequency parameter is set incorrectly. The frequency must be a positive from 0 to 1.

Definition at line 581 of file dspl.h.

## ◆ ERROR_FNAME

 #define ERROR_FNAME   0x06140113

Error in file name. You must specify the correct file name.

Definition at line 582 of file dspl.h.

## ◆ ERROR_FOPEN

 #define ERROR_FOPEN   0x06151605

Error opening file. A file with the specified name cannot be opened for writing or reading.

Definition at line 583 of file dspl.h.

Error reading data block from binary file. An error occurs if size of the read block does not match the required value.

Definition at line 584 of file dspl.h.

## ◆ ERROR_FWRITE_SIZE

 #define ERROR_FWRITE_SIZE   0x06231820

Error writing data to binary file. An error occurs if, the size of the recorded block does not match the required value.

Definition at line 586 of file dspl.h.

## ◆ ERROR_GNUPLOT_CREATE

 #define ERROR_GNUPLOT_CREATE   0x07161203

Unable to connect to the GNUPLOT package. Please check that the package is available.

Definition at line 588 of file dspl.h.

## ◆ ERROR_GNUPLOT_TERM

 #define ERROR_GNUPLOT_TERM   0x07161220

Unknown program call parameter specifying the GNUPLOT terminal.
This parameter can be one of the following values:
--noplot no plotting; \ n --plotwin plot in the new window;
--plotpng plot in png file.
.

Definition at line 590 of file dspl.h.

## ◆ ERROR_LAPACK

 #define ERROR_LAPACK   0x12011601

The built-in LAPACK function returned an error code. This error is returned by the function if it uses one of the built-in LAPACK functions that failed.

Definition at line 597 of file dspl.h.

## ◆ ERROR_MALLOC

 #define ERROR_MALLOC   0x13011212

Dynamic memory allocation error. This error means that an error occurred while dynamically allocating memory. As a result, the malloc function in the body of the called function returned aNULL pointer. Further processing by the function is not possible.

Definition at line 599 of file dspl.h.

## ◆ ERROR_MATRIX_SIZE

 #define ERROR_MATRIX_SIZE   0x13011926

Matrix size error.

Definition at line 600 of file dspl.h.

## ◆ ERROR_MIN_MAX

 #define ERROR_MIN_MAX   0x13091413

The minimum value (lower bound) is greater than the maximum.

Definition at line 601 of file dspl.h.

## ◆ ERROR_NEGATIVE

 #define ERROR_NEGATIVE   0x14050701

Negative parameter. The function returns the given error code when it takes a negative parameter. into a variable that cannot be negative.

Definition at line 604 of file dspl.h.

## ◆ ERROR_POLY_AN

 #define ERROR_POLY_AN   0x16150114

The senior coefficient of the polynomial is incorrectly set. For example, when calculating the roots of a polynomial of degree $$N$$.

$P_N (x) = a_0 + a_1 x + a_2 x ^ 2 + \ ldots a_N x ^ N$

the leading coefficient $$a_N$$ cannot be equal to zero.

Definition at line 608 of file dspl.h.

## ◆ ERROR_POLY_ORD

 #define ERROR_POLY_ORD   0x16151518

The polynomial order is incorrect. The order of the polynomial must be a positive integer.

Definition at line 609 of file dspl.h.

## ◆ ERROR_PTR

 #define ERROR_PTR   0x16201800

Pointer error. This error means that one of the required pointers (memory to be allocated for) is transferred as NULL. When this error occurs, the function exits and returns the given error code.

Definition at line 610 of file dspl.h.

## ◆ ERROR_RAND_SIGMA

 #define ERROR_RAND_SIGMA   0x18011909

The standard deviation is incorrect normal distribution of a random variable. The standard deviation should be non-negative real number.

Definition at line 613 of file dspl.h.

## ◆ ERROR_RAND_TYPE

 #define ERROR_RAND_TYPE   0x18012009

Unknown pseudorandom number genration algorithm. The following algorithms are used in the library:

• MRG32K3A – 32 bit algortithm MRG32K3A was developed by Pierre Lecuer.
• MT19937-64 – 64-bit Mersenne Twister algorithm.

Definition at line 614 of file dspl.h.

## ◆ ERROR_RESAMPLE_FRAC_DELAY

 #define ERROR_RESAMPLE_FRAC_DELAY   0x18050604

Invalid fractional delay value. The fractional delay can take values from -1 to 1, where 1 corresponds to one sampling interval $$1 / F_{\textrm{s}}$$.

Definition at line 616 of file dspl.h.

## ◆ ERROR_RESAMPLE_RATIO

 #define ERROR_RESAMPLE_RATIO   0x18051801

The resampling factor is set incorrectly. The resampling factor is given by the relation $$\frac{P}{Q}$$, where $$P$$ and $$Q$$ are real positive numbers.

Definition at line 615 of file dspl.h.

## ◆ ERROR_SIZE

 #define ERROR_SIZE   0x19092605

Error array size. This error occurs when in addition to the pointer the wrong input is passed to the input or output array size (less than or equal to zero). If this error occurs, the function exits and returns the given error code.

Definition at line 618 of file dspl.h.

## ◆ ERROR_SYM_TYPE

 #define ERROR_SYM_TYPE   0x19251320

Parameter error of type of filling arrays in linear or logarithmic scale. Valid fill types are symmetric and periodic.

Definition at line 619 of file dspl.h.

## ◆ ERROR_UNWRAP

 #define ERROR_UNWRAP   0x21142318

Error in unwrap function. The phase period and indent parameter must be positive numbers.

Definition at line 622 of file dspl.h.

## ◆ ERROR_WIN_PARAM

 #define ERROR_WIN_PARAM   0x23091601

window function parameter error. Valid parameter values exist for each parametric window function.

Definition at line 625 of file dspl.h.

## ◆ ERROR_WIN_SYM

 #define ERROR_WIN_SYM   0x23091925

Symmetry or periodicity of a given window is not supported.

Definition at line 626 of file dspl.h.

## ◆ ERROR_WIN_TYPE

 #define ERROR_WIN_TYPE   0x23092025

Unknown window function type.

Definition at line 627 of file dspl.h.

## ◆ RES_OK

 #define RES_OK   0

The function completed correctly. No errors.

Definition at line 558 of file dspl.h.