A Range Data Type
Functions | |
GiRange * | giraffe_range_new (void) |
Creates a new range. | |
GiRange * | giraffe_range_create (cxdouble min, cxdouble max) |
Creates a new range from the given minimum and maximum values. | |
void | giraffe_range_delete (GiRange *self) |
Destroys a range object. | |
void | giraffe_range_set_min (GiRange *self, cxdouble min) |
Set the minimum of a range. | |
cxdouble | giraffe_range_get_min (const GiRange *const self) |
Get the minimum of a range. | |
void | giraffe_range_set_max (GiRange *self, cxdouble max) |
Set the maximum of a range. | |
cxdouble | giraffe_range_get_max (const GiRange *const self) |
Get the maximum of a range. |
Detailed Description
TBDFunction Documentation
GiRange* giraffe_range_create | ( | cxdouble | min, | |
cxdouble | max | |||
) |
Creates a new range from the given minimum and maximum values.
- Parameters:
-
min The minimum value of the range. max The maximum value of the range.
- Returns:
- A newly allocated range if no errors occurred, or
NULL
otherwise.
Definition at line 91 of file girange.c.
Referenced by giraffe_rebin_get_wavelength_range(), giraffe_sgcalibration_config_create(), and giraffe_wlcalibration_config_create().
void giraffe_range_delete | ( | GiRange * | self | ) |
Destroys a range object.
- Parameters:
-
self The range to destroy.
- Returns:
- Nothing.
Definition at line 126 of file girange.c.
Referenced by giraffe_fov_build(), giraffe_sgcalibration_config_destroy(), and giraffe_wlcalibration_config_destroy().
cxdouble giraffe_range_get_max | ( | const GiRange *const | self | ) |
Get the maximum of a range.
- Parameters:
-
self The range to be queried.
- Returns:
- The current maximum of the range.
Definition at line 221 of file girange.c.
Referenced by giraffe_fov_build(), and giraffe_integrate_flux().
cxdouble giraffe_range_get_min | ( | const GiRange *const | self | ) |
Get the minimum of a range.
- Parameters:
-
self The range to be queried.
- Returns:
- The current minimum of the range.
Definition at line 175 of file girange.c.
Referenced by giraffe_fov_build(), and giraffe_integrate_flux().
GiRange* giraffe_range_new | ( | void | ) |
void giraffe_range_set_max | ( | GiRange * | self, | |
cxdouble | max | |||
) |
Set the maximum of a range.
- Parameters:
-
self The range to be updated. max The value to be set as maximum.
- Returns:
- Nothing.
Definition at line 198 of file girange.c.
Referenced by giraffe_fov_build().
void giraffe_range_set_min | ( | GiRange * | self, | |
cxdouble | min | |||
) |
Set the minimum of a range.
- Parameters:
-
self The range to be updated. min The value to be set as minimum.
- Returns:
- Nothing.
Definition at line 152 of file girange.c.
Referenced by giraffe_fov_build().