fnft__manakovv_testcases.h File Reference

Provides test cases for the tests of fnft_manakovv. More...

#include "fnft_manakovv.h"

Include dependency graph for fnft__manakovv_testcases.h:

Go to the source code of this file.

Enumerations
enum	fnft__manakovv_testcases_t { fnft__manakovv_testcases_SECH_FOCUSING , fnft__manakovv_testcases_SECH_DEFOCUSING , fnft__manakovv_testcases_RECTANGLE_FOCUSING }

Functions
FNFT_INT	fnft__manakovv_testcases_test_fnft (fnft__manakovv_testcases_t tc, FNFT_UINT D, const FNFT_REAL eb[5], fnft_manakovv_opts_t *const opts)
	Routine to run tests for fnft_manakovv. .

Detailed Description

Provides test cases for the tests of fnft_manakovv.

Enumeration Type Documentation

fnft__manakovv_testcases_t

enum fnft__manakovv_testcases_t

List of currently implemented test cases for the Manakov equation

fnft__manakovv_testcases_SECH_FOCUSING : Test for focusing Manakov (kappa = +1) with a sech potential.

fnft__manakovv_testcases_SECH_DEFOCUSING : Test for defocusing Manakov (kappa = -1) with a sech potential.

fnft__manakovv_testcases_RECTANGLE_FOCUSING : Test for focusing Manakov (kappa = 1) with a rectangle potential.

Function Documentation

fnft__manakovv_testcases_test_fnft()

FNFT_INT fnft__manakovv_testcases_test_fnft	(	fnft__manakovv_testcases_t	tc,
		FNFT_UINT	D,
		const FNFT_REAL	eb[5],
		fnft_manakovv_opts_t *const	opts
	)

Routine to run tests for fnft_manakovv.
.

This routine is used by the tests for fnft_manakovv. It runs the specified test case tc with the specificed number of samples D and the options opts, and tests if several errors stay below the provided error bounds in eb.

Parameters

[in]	tc	Type of test case.
[in]	D	Number of samples.
[in]	eb	Real valued array with 5 elements corresponding to various error bounds.
[in]	opts	fnft_manakovv_opts_t options for the tests.

Returns

If all errors stay below bounds the routine FNFT_SUCCESS. Otherwise, it returns an error code (normally, FNFT_EC_TEST_FAILED).