jb::fftw::detail Namespace Reference

Functions
void	check_plan_inputs (std::size_t in_elements, std::size_t on_elements, std::size_t in_nsamples, std::size_t on_nsamples, char const *function_name)
	Helper function to check the inputs to a create_*_plan_*() More...

Function Documentation

check_plan_inputs()

void jb::fftw::detail::check_plan_inputs	(	std::size_t	in_elements,
		std::size_t	on_elements,
		std::size_t	in_nsamples,
		std::size_t	on_nsamples,
		char const *	function_name
	)

Helper function to check the inputs to a create_*_plan_*()

Parameters

in_elements	the number of elements in the input vector or array
on_elements	the number of elements in the output vector or array
in_nsamples	the number of samples per-timeseries in the input array
on_nsamples	the number of samples per timeseries in the output array
function_name	the name of the function to include in the exception message if a problem is detected

Exceptions

std::invalid_argument

if the sizes do not match, with a descriptive message.

Definition at line 10 of file plan.cpp.

Referenced by jb::fftw::create_backward_plan(), jb::fftw::create_forward_plan(), and jb::fftw::plan< timeseries_type, frequency_timeseries_type >::execute().