AliCheb3DCalc.cxx

/**************************************************************************
 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 *                                                                        *
 * Author: The ALICE Off-line Project.                                    *
 * Contributors are mentioned in the code where appropriate.              *
 *                                                                        *
 * Permission to use, copy, modify and distribute this software and its   *
 * documentation strictly for non-commercial purposes is hereby granted   *
 * without fee, provided that the above copyright notice appears in all   *
 * copies and that both the copyright notice and this permission notice   *
 * appear in the supporting documentation. The authors make no claims     *
 * about the suitability of this software for any purpose. It is          *
 * provided "as is" without express or implied warranty.                  *
 **************************************************************************/

#include <cstdlib>
#include <TSystem.h>
#include "AliCheb3DCalc.h"
#include "AliLog.h"

ClassImp(AliCheb3DCalc)

//__________________________________________________________________________________________
AliCheb3DCalc::AliCheb3DCalc() :
  fNCoefs(0), 
  fNRows(0), 
  fNCols(0), 
  fNElemBound2D(0), 
  fNColsAtRow(0), 
  fColAtRowBg(0),
  fCoefBound2D0(0), 
  fCoefBound2D1(0), 
  fCoefs(0), 
  fTmpCf1(0), 
  fTmpCf0(0),
  fPrec(0)
{
  // default constructor
}

//__________________________________________________________________________________________
AliCheb3DCalc::AliCheb3DCalc(const AliCheb3DCalc& src) :
  TNamed(src), 
  fNCoefs(src.fNCoefs), 
  fNRows(src.fNRows), 
  fNCols(src.fNCols),
  fNElemBound2D(src.fNElemBound2D), 
  fNColsAtRow(0), 
  fColAtRowBg(0), 
  fCoefBound2D0(0), 
  fCoefBound2D1(0), 
  fCoefs(0), 
  fTmpCf1(0), 
  fTmpCf0(0), 
  fPrec(src.fPrec)
{
  // copy constructor
  //
  if (src.fNColsAtRow) {
    fNColsAtRow = new UShort_t[fNRows]; 
    for (int i=fNRows;i--;) fNColsAtRow[i] = src.fNColsAtRow[i];
  }
  if (src.fColAtRowBg) {
    fColAtRowBg = new UShort_t[fNRows]; 
    for (int i=fNRows;i--;) fColAtRowBg[i] = src.fColAtRowBg[i];
  }
  if (src.fCoefBound2D0) {
    fCoefBound2D0 = new UShort_t[fNElemBound2D];
    for (int i=fNElemBound2D;i--;) fCoefBound2D0[i] = src.fCoefBound2D0[i];
  }
  if (src.fCoefBound2D1) {
    fCoefBound2D1 = new UShort_t[fNElemBound2D];
    for (int i=fNElemBound2D;i--;) fCoefBound2D1[i] = src.fCoefBound2D1[i];
  }
  if (src.fCoefs) {
    fCoefs = new Float_t[fNCoefs];
    for (int i=fNCoefs;i--;) fCoefs[i] = src.fCoefs[i];
  }
  if (src.fTmpCf1) fTmpCf1 = new Float_t[fNCols];
  if (src.fTmpCf0) fTmpCf0 = new Float_t[fNRows];
}

//__________________________________________________________________________________________
AliCheb3DCalc::AliCheb3DCalc(FILE* stream) :
  fNCoefs(0), 
  fNRows(0), 
  fNCols(0), 
  fNElemBound2D(0), 
  fNColsAtRow(0), 
  fColAtRowBg(0), 
  fCoefBound2D0(0), 
  fCoefBound2D1(0), 
  fCoefs(0), 
  fTmpCf1(0), 
  fTmpCf0(0),
  fPrec(0)
{
  // constructor from coeffs. streem
  LoadData(stream);
}

//__________________________________________________________________________________________
AliCheb3DCalc& AliCheb3DCalc::operator=(const AliCheb3DCalc& rhs)
{
  // assignment operator
  if (this != &rhs) {
    Clear();
    SetName(rhs.GetName());
    SetTitle(rhs.GetTitle());
    fNCoefs = rhs.fNCoefs;
    fNRows  = rhs.fNRows;
    fNCols  = rhs.fNCols;    
    fPrec   = rhs.fPrec;
    if (rhs.fNColsAtRow) {
      fNColsAtRow = new UShort_t[fNRows]; 
      for (int i=fNRows;i--;) fNColsAtRow[i] = rhs.fNColsAtRow[i];
    }
    if (rhs.fColAtRowBg) {
      fColAtRowBg = new UShort_t[fNRows]; 
      for (int i=fNRows;i--;) fColAtRowBg[i] = rhs.fColAtRowBg[i];
    }
    if (rhs.fCoefBound2D0) {
      fCoefBound2D0 = new UShort_t[fNElemBound2D];
      for (int i=fNElemBound2D;i--;) fCoefBound2D0[i] = rhs.fCoefBound2D0[i];
    }
    if (rhs.fCoefBound2D1) {
      fCoefBound2D1 = new UShort_t[fNElemBound2D];
      for (int i=fNElemBound2D;i--;) fCoefBound2D1[i] = rhs.fCoefBound2D1[i];
    }
    if (rhs.fCoefs) {
      fCoefs = new Float_t[fNCoefs];
      for (int i=fNCoefs;i--;) fCoefs[i] = rhs.fCoefs[i];
    }
    if (rhs.fTmpCf1) fTmpCf1 = new Float_t[fNCols];
    if (rhs.fTmpCf0) fTmpCf0 = new Float_t[fNRows];    
  }
  return *this;
}

//__________________________________________________________________________________________
void AliCheb3DCalc::Clear(const Option_t*)
{
  // delete all dynamycally allocated structures
  if (fTmpCf1)       { delete[] fTmpCf1;  fTmpCf1 = 0;}
  if (fTmpCf0)       { delete[] fTmpCf0;  fTmpCf0 = 0;}
  if (fCoefs)        { delete[] fCoefs;   fCoefs  = 0;}
  if (fCoefBound2D0) { delete[] fCoefBound2D0; fCoefBound2D0 = 0; }
  if (fCoefBound2D1) { delete[] fCoefBound2D1; fCoefBound2D1 = 0; }
  if (fNColsAtRow)   { delete[] fNColsAtRow;   fNColsAtRow = 0; }
  if (fColAtRowBg)   { delete[] fColAtRowBg;   fColAtRowBg = 0; }
  //
}

//__________________________________________________________________________________________
void AliCheb3DCalc::Print(const Option_t* ) const
{
  // print info
  printf("Chebyshev parameterization data %s for 3D->1 function. Prec:%e\n",GetName(),fPrec);
  int nmax3d = 0; 
  for (int i=fNElemBound2D;i--;) if (fCoefBound2D0[i]>nmax3d) nmax3d = fCoefBound2D0[i];
  printf("%d coefficients in %dx%dx%d matrix\n",fNCoefs,fNRows,fNCols,nmax3d);
  //
}

//__________________________________________________________________________________________
Float_t  AliCheb3DCalc::EvalDeriv(int dim, const Float_t  *par) const
{
  // evaluate Chebyshev parameterization derivative in given dimension  for 3D function.
  // VERY IMPORTANT: par must contain the function arguments ALREADY MAPPED to [-1:1] interval
  //
  int ncfRC;
  for (int id0=fNRows;id0--;) {
    int nCLoc = fNColsAtRow[id0];                   // number of significant coefs on this row
    if (!nCLoc) {fTmpCf0[id0]=0; continue;}
    // 
    int col0  = fColAtRowBg[id0];                   // beginning of local column in the 2D boundary matrix
    for (int id1=nCLoc;id1--;) {
      int id = id1+col0;
      if (!(ncfRC=fCoefBound2D0[id])) { fTmpCf1[id1]=0; continue;}
      if (dim==2) fTmpCf1[id1] = ChebEval1Deriv(par[2],fCoefs + fCoefBound2D1[id], ncfRC);
      else        fTmpCf1[id1] = ChebEval1D(par[2],fCoefs + fCoefBound2D1[id], ncfRC);
    }
    if (dim==1)   fTmpCf0[id0] = ChebEval1Deriv(par[1],fTmpCf1,nCLoc);
    else          fTmpCf0[id0] = ChebEval1D(par[1],fTmpCf1,nCLoc);
  }
  return (dim==0) ? ChebEval1Deriv(par[0],fTmpCf0,fNRows) : ChebEval1D(par[0],fTmpCf0,fNRows);
  //
}

//__________________________________________________________________________________________
Float_t  AliCheb3DCalc::EvalDeriv2(int dim1,int dim2, const Float_t  *par) const
{
  // evaluate Chebyshev parameterization 2n derivative in given dimensions  for 3D function.
  // VERY IMPORTANT: par must contain the function arguments ALREADY MAPPED to [-1:1] interval
  //
  Bool_t same = dim1==dim2;
  int ncfRC;
  for (int id0=fNRows;id0--;) {
    int nCLoc = fNColsAtRow[id0];                   // number of significant coefs on this row
    if (!nCLoc) {fTmpCf0[id0]=0; continue;}
    //
    int col0  = fColAtRowBg[id0];                   // beginning of local column in the 2D boundary matrix
    for (int id1=nCLoc;id1--;) {
      int id = id1+col0;
      if (!(ncfRC=fCoefBound2D0[id])) { fTmpCf1[id1]=0; continue;}
      if (dim1==2||dim2==2) fTmpCf1[id1] = same ? ChebEval1Deriv2(par[2],fCoefs + fCoefBound2D1[id], ncfRC) 
			      :                   ChebEval1Deriv(par[2],fCoefs + fCoefBound2D1[id], ncfRC);
      else        fTmpCf1[id1] = ChebEval1D(par[2],fCoefs + fCoefBound2D1[id], ncfRC);
    }
    if (dim1==1||dim2==1) fTmpCf0[id0] = same ? ChebEval1Deriv2(par[1],fTmpCf1,nCLoc):ChebEval1Deriv(par[1],fTmpCf1,nCLoc);
    else                  fTmpCf0[id0] = ChebEval1D(par[1],fTmpCf1,nCLoc);
  }
  return (dim1==0||dim2==0) ? (same ? ChebEval1Deriv2(par[0],fTmpCf0,fNRows):ChebEval1Deriv(par[0],fTmpCf0,fNRows)) : 
    ChebEval1D(par[0],fTmpCf0,fNRows);
  //
}

//_______________________________________________
#ifdef _INC_CREATION_ALICHEB3D_
void AliCheb3DCalc::SaveData(const char* outfile,Bool_t append) const
{
  // writes coefficients data to output text file, optionallt appending on the end of existing file
  TString strf = outfile;
  gSystem->ExpandPathName(strf);
  FILE* stream = fopen(strf,append ? "a":"w");
  SaveData(stream);
  fclose(stream);
  //
}
#endif

//_______________________________________________
#ifdef _INC_CREATION_ALICHEB3D_
void AliCheb3DCalc::SaveData(FILE* stream) const
{
  // writes coefficients data to existing output stream
  // Note: fNCols, fNElemBound2D and fColAtRowBg is not stored, will be computed on fly during the loading of this file
  fprintf(stream,"#\nSTART %s\n",GetName());
  fprintf(stream,"# Number of rows\n%d\n",fNRows);
  //
  fprintf(stream,"# Number of columns per row\n");
  for (int i=0;i<fNRows;i++) fprintf(stream,"%d\n",fNColsAtRow[i]);
  //
  fprintf(stream,"# Number of Coefs in each significant block of third dimension\n");
  for (int i=0;i<fNElemBound2D;i++) fprintf(stream,"%d\n",fCoefBound2D0[i]);
  //
  fprintf(stream,"# Coefficients\n");
  for (int i=0;i<fNCoefs;i++) fprintf(stream,"%+.8e\n",fCoefs[i]);
  //
  fprintf(stream,"# Precision\n");
  fprintf(stream,"%+.8e\n",fPrec);
  //
  fprintf(stream,"END %s\n",GetName());
  //
}
#endif

//_______________________________________________
void AliCheb3DCalc::LoadData(FILE* stream)
{
  // Load coefs. from the stream 
  if (!stream) AliFatal("No stream provided");
  TString buffs;
  Clear();
  ReadLine(buffs,stream);
  if (!buffs.BeginsWith("START")) AliFatalF("Expected: \"START <fit_name>\", found \"%s\"",buffs.Data());
  if (buffs.First(' ')>0) SetName(buffs.Data()+buffs.First(' ')+1);
  //
  ReadLine(buffs,stream); // NRows
  fNRows = buffs.Atoi(); 
  if (fNRows<0 && !buffs.IsDigit()) AliFatalF("Expected: '<number_of_rows>', found \"%s\"",buffs.Data());
  //
  fNCols = 0;
  fNElemBound2D = 0;
  InitRows(fNRows);
  //
  for (int id0=0;id0<fNRows;id0++) {
    ReadLine(buffs,stream);               // n.cols at this row
    fNColsAtRow[id0] = buffs.Atoi();
    fColAtRowBg[id0] = fNElemBound2D;     // begining of this row in 2D boundary surface
    fNElemBound2D   += fNColsAtRow[id0];
    if (fNCols<fNColsAtRow[id0]) fNCols = fNColsAtRow[id0];
  }
  InitCols(fNCols);
  //  
  fNCoefs = 0; 
  InitElemBound2D(fNElemBound2D);
  //
  for (int i=0;i<fNElemBound2D;i++) {
    ReadLine(buffs,stream);               // n.coeffs at 3-d dimension for the given column/row
    fCoefBound2D0[i] = buffs.Atoi();
    fCoefBound2D1[i] = fNCoefs;
    fNCoefs += fCoefBound2D0[i];
  }
  //
  InitCoefs(fNCoefs);
  for (int i=0;i<fNCoefs;i++) {
    ReadLine(buffs,stream);
    fCoefs[i] = buffs.Atof();
  }
  //
  // read precision
  ReadLine(buffs,stream);
  fPrec = buffs.Atof();
  //
  // check end_of_data record
  ReadLine(buffs,stream);
  if (!buffs.BeginsWith("END") || !buffs.Contains(GetName())) AliFatalF("Expected \"END %s\", found \"%s\"",GetName(),buffs.Data());
  //
}

//_______________________________________________
void AliCheb3DCalc::ReadLine(TString& str,FILE* stream) 
{
  // read single line from the stream, skipping empty and commented lines. EOF is not expected
  while (str.Gets(stream)) {
    str = str.Strip(TString::kBoth,' ');
    if (str.IsNull()||str.BeginsWith("#")) continue;
    return;
  }
  AliFatalGeneral("ReadLine","Failed to read from stream"); // normally, should not reach here
}

//_______________________________________________
void AliCheb3DCalc::InitCols(int nc)
{
  // Set max.number of significant columns in the coefs matrix
  fNCols = nc;
  if (fTmpCf1) {delete[] fTmpCf1; fTmpCf1 = 0;}
  if (fNCols>0) fTmpCf1 = new Float_t [fNCols];
}

//_______________________________________________
void AliCheb3DCalc::InitRows(int nr)
{
  // Set max.number of significant rows in the coefs matrix
  if (fNColsAtRow) {delete[] fNColsAtRow; fNColsAtRow = 0;}
  if (fColAtRowBg) {delete[] fColAtRowBg; fColAtRowBg = 0;}
  if (fTmpCf0)     {delete[] fTmpCf0; fTmpCf0 = 0;}
  fNRows = nr;
  if (fNRows>0) {
    fNColsAtRow = new UShort_t[fNRows];
    fTmpCf0     = new Float_t [fNRows];
    fColAtRowBg = new UShort_t[fNRows];
    for (int i=fNRows;i--;) fNColsAtRow[i] = fColAtRowBg[i] = 0;
  }
}

//_______________________________________________
void AliCheb3DCalc::InitElemBound2D(int ne)
{
  // Set max number of significant coefs for given row/column of coefs 3D matrix
  if (fCoefBound2D0) {delete[] fCoefBound2D0; fCoefBound2D0 = 0;}
  if (fCoefBound2D1) {delete[] fCoefBound2D1; fCoefBound2D1 = 0;}
  fNElemBound2D = ne;
  if (fNElemBound2D>0) {
    fCoefBound2D0 = new UShort_t[fNElemBound2D];
    fCoefBound2D1 = new UShort_t[fNElemBound2D];
    for (int i=fNElemBound2D;i--;) fCoefBound2D0[i] = fCoefBound2D1[i] = 0;
  }
}

//_______________________________________________
void AliCheb3DCalc::InitCoefs(int nc)
{
  // Set total number of significant coefs
  if (fCoefs) {delete[] fCoefs; fCoefs = 0;}
  fNCoefs = nc;
  if (fNCoefs>0) {
    fCoefs = new Float_t [fNCoefs];
    for (int i=fNCoefs;i--;) fCoefs[i] = 0.0;
  }
}

//__________________________________________________________________________________________
Float_t AliCheb3DCalc::ChebEval1Deriv(Float_t  x, const Float_t * array, int ncf )
{
  // evaluate 1D Chebyshev parameterization's derivative. x is the argument mapped to [-1:1] interval
  if (--ncf<1) return 0;
  Float_t b0, b1, b2;
  Float_t x2 = x+x;
  b1 = b2 = 0;
  float dcf0=0,dcf1,dcf2=0;
  b0 = dcf1 = 2*ncf*array[ncf];
  if (!(--ncf)) return b0/2;
  //
  for (int i=ncf;i--;) {
    b2 = b1;      
    b1 = b0;
    dcf0 = dcf2 + 2*(i+1)*array[i+1];
    b0 = dcf0 + x2*b1 -b2;
    dcf2 = dcf1;  
    dcf1 = dcf0;
  }
  //
  return b0 - x*b1 - dcf0/2;
}

//__________________________________________________________________________________________
Float_t AliCheb3DCalc::ChebEval1Deriv2(Float_t  x, const Float_t * array, int ncf )
{
  // evaluate 1D Chebyshev parameterization's 2nd derivative. x is the argument mapped to [-1:1] interval
  if (--ncf<2) return 0;
  Float_t b0, b1, b2;
  Float_t x2 = x+x;
  b1 = b2 = 0;
  float dcf0=0,dcf1=0,dcf2=0;
  float ddcf0=0,ddcf1,ddcf2=0;
  //
  dcf2 = 2*ncf*array[ncf]; 
  --ncf; 

  dcf1 = 2*ncf*array[ncf]; 
  b0 = ddcf1 = 2*ncf*dcf2; 
  //
  if (!(--ncf)) return b0/2;
  //
  for (int i=ncf;i--;) {
    b2 = b1;                        
    b1 = b0;
    dcf0  = dcf2 + 2*(i+1)*array[i+1];
    ddcf0 = ddcf2 + 2*(i+1)*dcf1; 
    b0 = ddcf0 + x2*b1 -b2;
    //
    ddcf2 = ddcf1;  
    ddcf1 = ddcf0;
    //
    dcf2 = dcf1;
    dcf1 = dcf0;
    //
  }
  //
  return b0 - x*b1 - ddcf0/2;
}

//__________________________________________________________________________________________
Int_t AliCheb3DCalc::GetMaxColsAtRow() const
{
  int nmax3d = 0; 
  for (int i=fNElemBound2D;i--;) if (fCoefBound2D0[i]>nmax3d) nmax3d = fCoefBound2D0[i];
  return nmax3d;
}