param_dble.h File Reference

#include "param.h"

Include dependency graph for param_dble.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
struct yac_param *	yac_param_dble_new (const char *name, double *value_ptr, double default_value, double value_min, double value_max, int allow_nan, int allow_inf, int has_default, int is_defined)
	Create a double parameter.

Function Documentation

yac_param_dble_new()

struct yac_param * yac_param_dble_new	(	const char *	name,
		double *	value_ptr,
		double	default_value,
		double	value_min,
		double	value_max,
		int	allow_nan,
		int	allow_inf,
		int	has_default,
		int	is_defined )

Create a double parameter.

Parameters

name	Name of the parameter
value_ptr	Pointer to the double value
default_value	Default value (ignored if has_default is false)
value_min	Minimum allowed value (inclusive)
value_max	Maximum allowed value (inclusive)
allow_nan	Allow NaN values (true/false)
allow_inf	Allow Inf values (true/false)
has_default	If true, parameter has a default value; if false, value is undefined until set
is_defined	If true, initial value is considered defined; if false, initial value is considered undefined and user must set it before getting

Returns

Pointer to new parameter handle

Definition at line 157 of file param_dble.c.

Here is the caller graph for this function: