Swapped the names AliMagFCheb and AliMagWrapCheb. The former should be used
[u/mrichter/AliRoot.git] / STEER / AliCheb3D.h
CommitLineData
0eea9d4d 1// Author: ruben.shahoyan@cern.ch 09/09/2006
40389866 2
0eea9d4d 3////////////////////////////////////////////////////////////////////////////////
4// //
5// AliCheb3D produces the interpolation of the user 3D->NDimOut arbitrary //
6// function supplied in "void (*fcn)(float* inp,float* out)" format //
7// either in a separate macro file or as a function pointer. //
8// Only coefficients needed to guarantee the requested precision are kept. //
9// //
10// The user-callable methods are: //
11// To create the interpolation use: //
12// AliCheb3D(const char* funName, // name of the file with user function //
13// or //
14// AliCheb3D(void (*ptr)(float*,float*),// pointer on the user function //
15// Int_t DimOut, // dimensionality of the function's output //
16// Float_t *bmin, // lower 3D bounds of interpolation domain //
17// Float_t *bmax, // upper 3D bounds of interpolation domain //
18// Int_t *npoints, // number of points in each of 3 input //
19// // dimension, defining the interpolation grid //
20// Float_t prec=1E-6); // requested max.absolute difference between //
21// // the interpolation and any point on grid //
22// //
23// To test obtained parameterization use the method //
24// TH1* TestRMS(int idim,int npoints = 1000,TH1* histo=0); //
25// it will compare the user output of the user function and interpolation //
26// for idim-th output dimension and fill the difference in the supplied //
27// histogram. If no histogram is supplied, it will be created. //
28// //
29// To save the interpolation data: //
30// SaveData(const char* filename, Bool_t append ) //
31// write text file with data. If append is kTRUE and the output file already //
32// exists, data will be added in the end of the file. //
33// Alternatively, SaveData(FILE* stream) will write the data to //
34// already existing stream. //
35// //
36// To read back already stored interpolation use either the constructor //
37// AliCheb3D(const char* inpFile); //
38// or the default constructor AliCheb3D() followed by //
39// AliCheb3D::LoadData(const char* inpFile); //
40// //
41// To compute the interpolation use Eval(float* par,float *res) method, with //
42// par being 3D vector of arguments (inside the validity region) and res is //
43// the array of DimOut elements for the output. //
44// //
45// If only one component (say, idim-th) of the output is needed, use faster //
46// Float_t Eval(Float_t *par,int idim) method. //
47// //
48// void Print(option="") will print the name, the ranges of validity and //
49// the absolute precision of the parameterization. Option "l" will also print //
50// the information about the number of coefficients for each output //
51// dimension. //
52// //
53// NOTE: during the evaluation no check is done for parameter vector being //
54// outside the interpolation region. If there is such a risk, use //
55// Bool_t IsInside(float *par) method. Chebyshev parameterization is not //
56// good for extrapolation! //
57// //
58// For the properties of Chebyshev parameterization see: //
59// H.Wind, CERN EP Internal Report, 81-12/Rev. //
60// //
61////////////////////////////////////////////////////////////////////////////////
62
63
5406439e 64#ifndef ALICHEB3D_H
65#define ALICHEB3D_H
66
0eea9d4d 67#include <TNamed.h>
0eea9d4d 68#include <TObjArray.h>
99adacae 69#include "AliCheb3DCalc.h"
70
0eea9d4d 71class TString;
72class TSystem;
73class TRandom;
5406439e 74class TH1;
75class TMethodCall;
76class TRandom;
77class TROOT;
78class stdio;
79
40389866 80
81
0eea9d4d 82class AliCheb3D: public TNamed
83{
84 public:
40389866 85 AliCheb3D();
86 AliCheb3D(const AliCheb3D& src);
87 AliCheb3D(const char* inpFile);
88 AliCheb3D(FILE* stream);
0eea9d4d 89 //
90#ifdef _INC_CREATION_ALICHEB3D_
91 AliCheb3D(const char* funName, Int_t DimOut, Float_t *bmin,Float_t *bmax, Int_t *npoints, Float_t prec=1E-6);
92 AliCheb3D(void (*ptr)(float*,float*), Int_t DimOut, Float_t *bmin,Float_t *bmax, Int_t *npoints, Float_t prec=1E-6);
40389866 93 AliCheb3D(void (*ptr)(float*,float*), int DimOut, Float_t *bmin,Float_t *bmax, Int_t *npX,Int_t *npY,Int_t *npZ, Float_t prec=1E-6);
94 AliCheb3D(void (*ptr)(float*,float*), int DimOut, Float_t *bmin,Float_t *bmax, Float_t prec=1E-6);
0eea9d4d 95#endif
96 //
97 ~AliCheb3D() {Clear();}
98 //
40389866 99 AliCheb3D& operator=(const AliCheb3D& rhs);
ff66b122 100 template <class T>
101 void Eval(const T *par, T *res);
102 template <class T>
103 T Eval(const T *par,int idim);
40389866 104 //
5406439e 105 void EvalDeriv(int dimd, const Float_t *par, Float_t *res);
106 void EvalDeriv2(int dimd1, int dimd2, const Float_t *par,Float_t *res);
107 Float_t EvalDeriv(int dimd, const Float_t *par, int idim);
108 Float_t EvalDeriv2(int dimd1,int dimd2, const Float_t *par, int idim);
109 void EvalDeriv3D(const Float_t *par, Float_t dbdr[3][3]);
110 void EvalDeriv3D2(const Float_t *par, Float_t dbdrdr[3][3][3]);
111 void Print(const Option_t* opt="") const;
ff66b122 112 template <class T>
113 Bool_t IsInside(const T *par) const;
114 //
0eea9d4d 115 AliCheb3DCalc* GetChebCalc(int i) const {return (AliCheb3DCalc*)fChebCalc.UncheckedAt(i);}
116 Float_t GetBoundMin(int i) const {return fBMin[i];}
117 Float_t GetBoundMax(int i) const {return fBMax[i];}
40389866 118 Float_t* GetBoundMin() const {return (float*)fBMin;}
119 Float_t* GetBoundMax() const {return (float*)fBMax;}
0eea9d4d 120 Float_t GetPrecision() const {return fPrec;}
121 void ShiftBound(int id,float dif);
122 //
123 void LoadData(const char* inpFile);
124 void LoadData(FILE* stream);
125 //
126#ifdef _INC_CREATION_ALICHEB3D_
40389866 127 int* GetNCNeeded(float xyz[3],int DimVar, float mn,float mx, float prec);
128 void EstimateNPoints(float Prec, int gridBC[3][3]);
0eea9d4d 129 void SaveData(const char* outfile,Bool_t append=kFALSE) const;
130 void SaveData(FILE* stream=stdout) const;
131 //
132 void SetUsrFunction(const char* name);
133 void SetUsrFunction(void (*ptr)(float*,float*));
da7cd221 134 void EvalUsrFunction(const Float_t *x, Float_t *res);
0eea9d4d 135 TH1* TestRMS(int idim,int npoints = 1000,TH1* histo=0);
5406439e 136 static Int_t CalcChebCoefs(const Float_t *funval,int np, Float_t *outCoefs, Float_t prec=-1);
0eea9d4d 137#endif
138 //
139 protected:
5406439e 140 void Clear(const Option_t* option = "");
141 void SetDimOut(const int d);
142 void PrepareBoundaries(const Float_t *bmin,const Float_t *bmax);
0eea9d4d 143 //
144#ifdef _INC_CREATION_ALICHEB3D_
145 void EvalUsrFunction();
146 void DefineGrid(Int_t* npoints);
147 Int_t ChebFit(); // fit all output dimensions
148 Int_t ChebFit(int dmOut);
0eea9d4d 149#endif
150 //
ff66b122 151 template <class T>
152 T MapToInternal(T x,Int_t d) const; // map x to [-1:1]
153 template <class T>
154 T MapToExternal(T x,Int_t d) const {return x/fBScale[d]+fBOffset[d];} // map from [-1:1] to x
40389866 155 //
0eea9d4d 156 protected:
157 Int_t fDimOut; // dimension of the ouput array
158 Float_t fPrec; // requested precision
159 Float_t fBMin[3]; // min boundaries in each dimension
160 Float_t fBMax[3]; // max boundaries in each dimension
161 Float_t fBScale[3]; // scale for boundary mapping to [-1:1] interval
162 Float_t fBOffset[3]; // offset for boundary mapping to [-1:1] interval
163 TObjArray fChebCalc; // Chebyshev parameterization for each output dimension
164 //
165 Int_t fMaxCoefs; //! max possible number of coefs per parameterization
166 Int_t fNPoints[3]; //! number of used points in each dimension
167 Float_t fArgsTmp[3]; //! temporary vector for coefs caluclation
168 Float_t fBuff[6]; //! buffer for coordinate transformations
169 Float_t * fResTmp; //! temporary vector for results of user function caluclation
170 Float_t * fGrid; //! temporary buffer for Chebyshef roots grid
171 Int_t fGridOffs[3]; //! start of grid for each dimension
172 TString fUsrFunName; //! name of user macro containing the function of "void (*fcn)(float*,float*)" format
173 TMethodCall* fUsrMacro; //! Pointer to MethodCall for function from user macro
174 //
175 ClassDef(AliCheb3D,1) // Chebyshev parametrization for 3D->N function
176};
177
0eea9d4d 178//__________________________________________________________________________________________
ff66b122 179template <class T>
180inline Bool_t AliCheb3D::IsInside(const T *par) const
0eea9d4d 181{
182 // check if the point is inside of the fitted box
40389866 183 const float kTol = 1.e-4;
184 for (int i=3;i--;) if (fBMin[i]-par[i]>kTol || par[i]-fBMax[i]>kTol) return kFALSE;
185 //if(par[i]<fBMin[i]||par[i]>fBMax[i]) return kFALSE;
0eea9d4d 186 return kTRUE;
187}
188
0eea9d4d 189//__________________________________________________________________________________________
ff66b122 190template <class T>
191inline void AliCheb3D::Eval(const T *par, T *res)
0eea9d4d 192{
193 // evaluate Chebyshev parameterization for 3d->DimOut function
194 for (int i=3;i--;) fArgsTmp[i] = MapToInternal(par[i],i);
195 for (int i=fDimOut;i--;) res[i] = GetChebCalc(i)->Eval(fArgsTmp);
196 //
197}
198
199//__________________________________________________________________________________________
ff66b122 200template <class T>
201inline T AliCheb3D::Eval(const T *par, int idim)
0eea9d4d 202{
203 // evaluate Chebyshev parameterization for idim-th output dimension of 3d->DimOut function
204 for (int i=3;i--;) fArgsTmp[i] = MapToInternal(par[i],i);
205 return GetChebCalc(idim)->Eval(fArgsTmp);
206 //
207}
208
40389866 209//__________________________________________________________________________________________
5406439e 210inline void AliCheb3D::EvalDeriv3D(const Float_t *par, Float_t dbdr[3][3])
40389866 211{
212 // return gradient matrix
213 for (int i=3;i--;) fArgsTmp[i] = MapToInternal(par[i],i);
214 for (int ib=3;ib--;) for (int id=3;id--;) dbdr[ib][id] = GetChebCalc(ib)->EvalDeriv(id,fArgsTmp)*fBScale[id];
215}
216
1cf34ee8 217//__________________________________________________________________________________________
5406439e 218inline void AliCheb3D::EvalDeriv3D2(const Float_t *par, Float_t dbdrdr[3][3][3])
1cf34ee8 219{
220 // return gradient matrix
221 for (int i=3;i--;) fArgsTmp[i] = MapToInternal(par[i],i);
222 for (int ib=3;ib--;) for (int id=3;id--;)for (int id1=3;id1--;)
223 dbdrdr[ib][id][id1] = GetChebCalc(ib)->EvalDeriv2(id,id1,fArgsTmp)*fBScale[id]*fBScale[id1];
224}
225
40389866 226//__________________________________________________________________________________________
5406439e 227inline void AliCheb3D::EvalDeriv(int dimd, const Float_t *par, Float_t *res)
40389866 228{
229 // evaluate Chebyshev parameterization derivative for 3d->DimOut function
230 for (int i=3;i--;) fArgsTmp[i] = MapToInternal(par[i],i);
231 for (int i=fDimOut;i--;) res[i] = GetChebCalc(i)->EvalDeriv(dimd,fArgsTmp)*fBScale[dimd];;
232 //
233}
234
1cf34ee8 235//__________________________________________________________________________________________
5406439e 236inline void AliCheb3D::EvalDeriv2(int dimd1,int dimd2, const Float_t *par, Float_t *res)
1cf34ee8 237{
238 // evaluate Chebyshev parameterization 2nd derivative over dimd1 and dimd2 dimensions for 3d->DimOut function
239 for (int i=3;i--;) fArgsTmp[i] = MapToInternal(par[i],i);
240 for (int i=fDimOut;i--;) res[i] = GetChebCalc(i)->EvalDeriv2(dimd1,dimd2,fArgsTmp)*fBScale[dimd1]*fBScale[dimd2];
241 //
242}
243
40389866 244//__________________________________________________________________________________________
5406439e 245inline Float_t AliCheb3D::EvalDeriv(int dimd, const Float_t *par, int idim)
0eea9d4d 246{
40389866 247 // evaluate Chebyshev parameterization derivative over dimd dimention for idim-th output dimension of 3d->DimOut function
248 for (int i=3;i--;) fArgsTmp[i] = MapToInternal(par[i],i);
249 return GetChebCalc(idim)->EvalDeriv(dimd,fArgsTmp)*fBScale[dimd];
0eea9d4d 250 //
251}
252
1cf34ee8 253//__________________________________________________________________________________________
5406439e 254inline Float_t AliCheb3D::EvalDeriv2(int dimd1,int dimd2, const Float_t *par, int idim)
1cf34ee8 255{
256 // evaluate Chebyshev parameterization 2ns derivative over dimd1 and dimd2 dimensions for idim-th output dimension of 3d->DimOut function
257 for (int i=3;i--;) fArgsTmp[i] = MapToInternal(par[i],i);
258 return GetChebCalc(idim)->EvalDeriv2(dimd1,dimd2,fArgsTmp)*fBScale[dimd1]*fBScale[dimd2];
259 //
260}
261
40389866 262//__________________________________________________________________________________________
ff66b122 263template <class T>
264inline T AliCheb3D::MapToInternal(T x,Int_t d) const
0eea9d4d 265{
40389866 266 // map x to [-1:1]
267#ifdef _BRING_TO_BOUNDARY_
ff66b122 268 T res = (x-fBOffset[d])*fBScale[d];
40389866 269 if (res<-1) return -1;
270 if (res> 1) return 1;
271 return res;
272#else
273 return (x-fBOffset[d])*fBScale[d];
274#endif
0eea9d4d 275}
276
277#endif