/******************************** LICENSE ********************************

 Copyright 2007 European Centre for Medium-Range Weather Forecasts (ECMWF)

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at 

    http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.

 ******************************** LICENSE ********************************/

/*! \file Akima760Method.h
    \brief Definition of the Template class Akima760Method.
    
    Magics Team - ECMWF 2004
    
    Started: Thu 11-Mar-2004
    
    Changes:
    
*/

#ifndef Akima760Method_H
#define Akima760Method_H

#include "magics.h"

#include "ContourMethod.h"
#include "Akima760MethodAttributes.h"

namespace magics {


class Akima760 : public MatrixHandler
{
public : 

    Akima760(const AbstractMatrix& matrix, const Akima760MethodAttributes&);

    ~Akima760(); 

    double operator()(int  i, int  j) const;
    int rowIndex(double r) const;
    int columnIndex(double r) const;
    void boundRow(double r, double& row1, int& index1, double& row2, int& index2) const;
                     
    void boundColumn(double r, double& column1, int& index1, double& column2, int& index2) const; 
    /*
    double interpolate(double  i, double  j) const { 
    	return this->matrix_.interpolate(i,j); 
   }  
   */

    int  rows() const {
	    return nrows_;
    }
    int  columns() const { 
	    return ncols_;
    }
    
    double regular_row(int i) const;
    double regular_column(int j) const;
    
    double column(int, int) const;
    double row(int, int) const;
    
    double missing() const  { 
    	return this->matrix_.missing(); 
    }

    // Compute partial derivatives of a bivariate function 
    // on a rectangular grid
    void rgpd3p();

    // Rectangular-grid bivariate interpolation
    double rgbi3p(double xi, double yi) const;

    // Location of the desired points in a rectangular grid
    // Remove  later
    void rglctn(double xi, double yi, int& inxi, int& inyi) const;

    // Polynomials for rectangular-grid bivariate interpolation
    // and surface fitting
    void rgplnl(double xi, double yi, int inxi, int inyi, double& zi) const;

    // Check missing values
    int CheckMissingValues(int col, int lin) const;

//TEST, REMOVE LATER
//void test_build_data();

private:

//     MonotonicIncreasingMatrixHandler mono1_; //Akima needs indexes in the monotonic increasing order
//     MatrixHandler mono_;
    //It is expected that the input Matrix is monotonic increasing and
    //already cached
     Akima760MethodAttributes attr_;
     int                nrows_;         // number of rows
     int                ncols_;         // number of columns
     double             **WKZX_;        // working array
     double             **WKZY_;        // working array
     double             **WKZXY_;       // working array
     int                monoRows_;
     int                monoColumns_;
     bool               missingValues_; // True: data has missing values
     map<double, int> rowsMap_;
     map<double, int> columnsMap_; 
     vector<double> rows_;
     vector<double> columns_;
     
};




class Akima760Method: public ContourMethod, public Akima760MethodAttributes {
public:
	Akima760Method() { MagLog::dev() << "Akima760Method::Akima760Method-->" << *this << "\n"; } 
	virtual ~Akima760Method() {}
    
    ContourMethod* clone() const {
    	Akima760Method* method = new Akima760Method();
    	method->copy(*this);
    	return method;
    }
    
    virtual void set(const map<string, string>& map) {
    	Akima760MethodAttributes::set(map);
    }
    
    virtual void set(const XmlNode& node) {
    	Akima760MethodAttributes::set(node);
    }
    virtual bool accept(const string& node) { return Akima760MethodAttributes::accept(node);; }

    virtual MatrixHandler* handler(const AbstractMatrix& matrix, const BasicGraphicsObjectContainer&) {
        return new Akima760(matrix,*this);
	}
    
protected:
     //! Method to print string about this class on to a stream of type ostream (virtual).
	 virtual void print(ostream& out) const { 
         out << "Akima760Method[";
         Akima760MethodAttributes::print(out);
         out << "]";
	 }  

private:
    //! Copy constructor - No copy allowed
	Akima760Method(const Akima760Method&); 
    //! Overloaded << operator to copy - No copy allowed
	Akima760Method& operator=(const Akima760Method&);
    
// -- Friends
    //! Overloaded << operator to call print().
	friend ostream& operator<<(ostream& s,const Akima760Method& p)
		{ p.print(s); return s; }

};

} // namespace magics



#endif
