ama_options Struct Reference

This structure is used to maintain the **AMA Spline Library** environment.
More...

`#include <AMA.h>`

## Public Attributes | |

Input Members | |

These members should be initialized with AMA_Options() and then modified to set user preferences prior to invoking any other AMA Spline Library Functions. If they are not initialized with AMA_Options() prior to invoking an AMA Function, then the function will produce either an AMA Initialization Error or a segmentation fault. See General Options Functions for | |

enum AMA_ErrorFlag | errorFlag |

Error messsage flag. More... | |

FILE * | errorFp |

Error message file pointer. More... | |

long int | outputFlag |

Output level flag. More... | |

FILE * | outputFp |

Output file pointer. More... | |

Output Members | |

These members are defined by AMA Spline Library Functions prior to returning to their calling function. | |

long int | ier |

The maximum Success/Error Code produced by an AMA Function and all AMA Spline Library functions it invoked. More... | |

double | lwrbnd |

The lower bound imposed on a spline approximation. More... | |

double | uprbnd |

The upper bound imposed on a spline approximation. More... | |

This structure is used to maintain the **AMA Spline Library** environment.

Its input members control **AMA Spline Library's** error reporting and the output written by AMA Spline Library Functions. The initial values defined by AMA_Options() are appropriate for most applications. All user callable functions, see AMA Spline Library Functions, have an AMA_OPTIONS input parameter which supports the **AMA Spline Library's** error reporting mechanism. If these members are not initialized with AMA_Options(), then invoking any of the other AMA Spline Library Functions causes the function to produce either an AMA Initialization Error or a segmentation fault. Functions for setting these members are given in General Options Functions.

**Input/Output Structure - Documented 121214**

enum AMA_ErrorFlag ama_options::errorFlag |

Error messsage flag.

The value of errorFlag enables or disables the **AMA Spline Library's** error reporting. It has one of the two following values:

- If errorFlag equals AMA_ErrorFlag_Enabled, then error/warning messages are reported by
**AMA Spline Library**functions. - If errorFlag equals AMA_ErrorFlag_Disabled, then error/warning messages are not reported.

It is initialized to AMA_ErrorFlag_Enabled. All error/warning messages are written to errorFp.

FILE* ama_options::errorFp |

Error message file pointer.

Error/warning messages reported by AMA Spline Library Functions are written to the file referenced by errorFp whenever errorFlag equals AMA_ErrorFlag_Enabled. It is initialized to stdout.

long int ama_options::ier |

The maximum Success/Error Code produced by an AMA Function and all **AMA Spline Library** functions it invoked.

It is initialized to AMA_NO_ERROR. See Success/Error Code for additional information.

double ama_options::lwrbnd |

The lower bound imposed on a spline approximation.

A univariate spline is subject to the bound and a multivariate spline is subject to the bound where and equals AMA_SplineInfbnd(). Therefore, by default, the splines are unbounded below but a finite lower bound can be set with AMA_OptionsSetBounds().

If a finite lower bound is set with AMA_OptionsSetBounds() prior to calling AMA_UnvLstsqr(), AMA_MltvLstsqr() or AMA_MltvGrdLstsqr(), then lwrbnd equals the value of the parameter **lwrbnd** passed to AMA_OptionsSetBounds().

If a finite lower bound is set with AMA_OptionsSetBounds() prior to calling AMA_MltvApprox(), AMA_MltvInterp(), AMA_MltvMonoApprox() or AMA_MltvMonoInterp(), then lwrbnd equals where is the largest lower bound that a spline can satisfy in conjunction with its approximation or interpolation constraints. See AMA_MltvApprox(), AMA_MltvInterp(), AMA_MltvMonoApprox() or AMA_MltvMonoInterp() documentation for additional information about .

long int ama_options::outputFlag |

Output level flag.

The value of outputFlag specifies the amount of output written to outputFp. If outputFlag equals zero, then the AMA Spline Library Functions do not produce any output. Must satisfy outputFlag . It is initialized to zero. It is also used to set CNSPLA_OPTION::otflag. If outputFlag , then CNSPLA_OPTION::otflag is set to outputFlag - 1. See CNSPLA_OPTION::otflag for additional information.

FILE* ama_options::outputFp |

Output file pointer.

The value of outputFp specifies the file to which all **AMA Spline Library** output is written. It is initialized to stdout. It is also used to set CNSPLA_OPTION::otfptr. See CNSPLA_OPTION::otfptr for additional information.

double ama_options::uprbnd |

The upper bound imposed on a spline approximation.

A univariate spline is subject to the bound and a multivariate spline is subject to the bound where and equals AMA_SplineInfbnd(). Therefore, by default, the splines are unbounded above but a finite upper bound can be set with AMA_OptionsSetBounds().

If a finite upper bound is set with AMA_OptionsSetBounds() prior to calling AMA_UnvLstsqr(), AMA_MltvLstsqr() or AMA_MltvGrdLstsqr(), then uprbnd equals the value of the parameter **uprbnd** passed to AMA_OptionsSetBounds().

If a finite upper bound is set with AMA_OptionsSetBounds() prior to calling AMA_MltvApprox(), AMA_MltvInterp(), AMA_MltvMonoApprox() or AMA_MltvMonoInterp(), then uprbnd equals where is the smallest upper bound that a spline can satisfy in conjunction with its approximation or interpolation constraints. See AMA_MltvApprox(), AMA_MltvInterp(), AMA_MltvMonoApprox() or AMA_MltvMonoInterp() documentation for additional information about .

The documentation for this struct was generated from the following file:

AMA Spline Library Document - Version:1.0.0-a Date:02/24/16 - Generated by 1.8.5