AMA_Options.h
Go to the documentation of this file.
1 
4 #ifndef AMA_OPTIONS_H
5 #define AMA_OPTIONS_H
6 
7 #include <cnspla.h>
8 #include <stdio.h>
9 #include <stdlib.h>
10 
11 /* -------------------------------------------------------------------------------------------------------------------------------
12  -------------------------------------------------------------------------------------------------------------------------------
13  --- THESE ARE USER CALLABLE FUNCTIONS ---
14  -------------------------------------------------------------------------------------------------------------------------------
15  ------------------------------------------------------------------------------------------------------------------------------- */
16 
17 long int AMA_Options ( AMA_OPTIONS **options );
18 
19 long int AMA_OptionsFree ( AMA_OPTIONS **options );
20 
21 long int AMA_OptionsSetBounds ( AMA_OPTIONS *options,
22  double lwrbnd ,
23  double uprbnd );
24 
25 long int AMA_OptionsSetCoefficients ( AMA_OPTIONS *options,
26  double alpha );
27 
28 long int AMA_OptionsSetContinuity ( AMA_OPTIONS *options ,
29  long int kindex ,
30  enum AMA_Continuity continuity );
31 
32 long int AMA_OptionsSetDefaults ( AMA_OPTIONS *options );
33 
34 long int AMA_OptionsSetErrorFlag ( AMA_OPTIONS *options ,
35  enum AMA_ErrorFlag errorFlag );
36 
37 long int AMA_OptionsSetErrorFp ( AMA_OPTIONS *options,
38  FILE *errorFp );
39 
40 long int AMA_OptionsSetExtrapolation ( AMA_OPTIONS *options ,
41  enum AMA_Boolean extrapolation );
42 
43 long int AMA_OptionsSetIterationLimit ( AMA_OPTIONS *options,
44  long int itrlim );
45 
46 long int AMA_OptionsSetInputCheck ( AMA_OPTIONS *options ,
47  enum AMA_Boolean inputCheck );
48 
49 long int AMA_OptionsSetMinimumNorm ( AMA_OPTIONS *options,
50  enum AMA_Boolean minorm );
51 
53  long int nind ,
54  long int *degree ,
55  long int **numcnd ,
56  enum AMA_BoundaryConditions **bndcnd ,
57  long int **ordlft ,
58  long int **ordrgh ,
59  AMA_SPLINE **bndlft ,
60  AMA_SPLINE **bndrgh );
61 
62 long int AMA_OptionsSetMonotonicity ( AMA_OPTIONS *options ,
63  long int kindex ,
64  enum AMA_Monotonicity monotonicity );
65 
66 long int AMA_OptionsSetOutputFlag ( AMA_OPTIONS *options ,
67  long int outputFlag );
68 
69 long int AMA_OptionsSetOutputFp ( AMA_OPTIONS *options ,
70  FILE *outputFp );
71 
72 long int AMA_OptionsSetPenaltyTerm ( AMA_OPTIONS *options,
73  long int kindex ,
74  long int lindex ,
75  enum AMA_Boolean pnltrm );
76 
78  long int degree ,
79  long int *numcnd ,
80  enum AMA_BoundaryConditions *bndcnd ,
81  long int *ordlft ,
82  long int *ordrgh ,
83  double *bndlft ,
84  double *bndrgh );
85 
86 long int AMA_OptionsWrite ( AMA_OPTIONS *options );
87 
88 /* -------------------------------------------------------------------------------------------------------------------------------
89  -------------------------------------------------------------------------------------------------------------------------------
90  --- THESE ARE USER SUPPORT FUNCTIONS ---
91  --- THESE FUNCTIONS CHECK INPUT MEMBERS OR SET INPUT AND OUTPUT MEMBERS OF USER DEFINABLE STRUCTURES ---
92  -------------------------------------------------------------------------------------------------------------------------------
93  ------------------------------------------------------------------------------------------------------------------------------- */
94 
95 long int AMA_OptionsCheck ( AMA_OPTIONS *options ,
96  const char *function );
97 
98 void AMA_OptionsInitialize ( AMA_OPTIONS *options );
99 
100 
101 #endif /* AMA_OPTIONS_H */
long int AMA_Options(AMA_OPTIONS **options)
Allocate and Initialize AMA_OPTIONS Structure
Definition: AMA_Options.c:30
FILE * errorFp
Error message file pointer.
Definition: AMA.h:353
FILE * outputFp
Output file pointer.
Definition: AMA.h:364
long int AMA_OptionsSetOutputFlag(AMA_OPTIONS *options, long int outputFlag)
Set Output Level Flag
Definition: AMA_Options.c:835
long int AMA_OptionsSetContinuity(AMA_OPTIONS *options, long int kindex, enum AMA_Continuity continuity)
Set Continuity Condition
Definition: AMA_Options.c:327
long int AMA_OptionsFree(AMA_OPTIONS **options)
Free AMA_OPTIONS Structure
Definition: AMA_Options.c:79
AMA_Continuity
This enumeration specifies the spline continuity condition imposed by the following AMA Functions: ...
Definition: AMA.h:224
long int AMA_OptionsSetErrorFp(AMA_OPTIONS *options, FILE *errorFp)
Set Error Message File
Definition: AMA_Options.c:475
long int AMA_OptionsSetPenaltyTerm(AMA_OPTIONS *options, long int kindex, long int lindex, enum AMA_Boolean pnltrm)
Set Penalty Term
Definition: AMA_Options.c:965
long int AMA_OptionsSetDefaults(AMA_OPTIONS *options)
Set AMA_OPTIONS Defaults
Definition: AMA_Options.c:387
AMA_ErrorFlag
This enumeration specifies if error messages are written to AMA_OPTIONS::errorFp. ...
Definition: AMA.h:281
double lwrbnd
The lower bound imposed on a spline approximation.
Definition: AMA.h:380
void AMA_OptionsInitialize(AMA_OPTIONS *options)
Initialize AMA_OPTIONS Structure
Definition: AMA_Options.c:1488
long int AMA_OptionsSetExtrapolation(AMA_OPTIONS *options, enum AMA_Boolean extrapolation)
Enable/Disable Extrapolation
Definition: AMA_Options.c:532
long int outputFlag
Output level flag.
Definition: AMA.h:357
double uprbnd
The upper bound imposed on a spline approximation.
Definition: AMA.h:391
long int AMA_OptionsSetBounds(AMA_OPTIONS *options, double lwrbnd, double uprbnd)
Set Spline Bounds
Definition: AMA_Options.c:161
long int AMA_OptionsSetOutputFp(AMA_OPTIONS *options, FILE *outputFp)
Set Output File
Definition: AMA_Options.c:886
long int AMA_OptionsSetErrorFlag(AMA_OPTIONS *options, enum AMA_ErrorFlag errorFlag)
Set Error Message Flag
Definition: AMA_Options.c:434
long int AMA_OptionsSetIterationLimit(AMA_OPTIONS *options, long int itrlim)
long int AMA_OptionsCheck(AMA_OPTIONS *options, const char *function)
Check AMA_OPTIONS.
Definition: AMA_Options.c:1414
This structure is used to maintain the AMA Spline Library environment.
Definition: AMA.h:335
long int AMA_OptionsSetMonotonicity(AMA_OPTIONS *options, long int kindex, enum AMA_Monotonicity monotonicity)
Enable/Disable Monotonicity Constraints
Definition: AMA_Options.c:760
long int AMA_OptionsWrite(AMA_OPTIONS *options)
Write AMA_OPTIONS Structure
Definition: AMA_Options.c:1286
AMA_Monotonicity
This enumeration specifies the monotonicity constraints imposed by the following AMA Functions: ...
Definition: AMA.h:269
long int AMA_OptionsSetUnvBoundaryConditions(AMA_OPTIONS *options, long int degree, long int *numcnd, enum AMA_BoundaryConditions *bndcnd, long int *ordlft, long int *ordrgh, double *bndlft, double *bndrgh)
Set boundary conditions for univariate approximation and interpolation functions
Definition: AMA_Options.c:1014
enum AMA_ErrorFlag errorFlag
Error messsage flag.
Definition: AMA.h:346
CNSPLA_SPLINE AMA_SPLINE
Definition: AMA.h:461
long int AMA_OptionsSetMltvBoundaryConditions(AMA_OPTIONS *options, long int nind, long int *degree, long int **numcnd, enum AMA_BoundaryConditions **bndcnd, long int **ordlft, long int **ordrgh, AMA_SPLINE **bndlft, AMA_SPLINE **bndrgh)
Set boundary conditions for multivariate approximation and interpolation functions ...
Definition: AMA_Options.c:679
long int AMA_OptionsSetCoefficients(AMA_OPTIONS *options, double alpha)
Set Spline Coefficient&#39;s Initial Value
Definition: AMA_Options.c:260
long int AMA_OptionsSetMinimumNorm(AMA_OPTIONS *options, enum AMA_Boolean minorm)
Enable/Disable Minimum Norm Optimimzation
Definition: AMA_Options.c:649
AMA_BoundaryConditions
This enumeration specifies the boundary conditions imposed by the following AMA Functions: ...
Definition: AMA.h:73
AMA_Boolean
This enumeration provides a boolean capability.
Definition: AMA.h:22
long int AMA_OptionsSetInputCheck(AMA_OPTIONS *options, enum AMA_Boolean inputCheck)
Enable/Disable Input Error Checking
Definition: AMA_Options.c:585