valuecalc.h

/* This file is part of the KDE project
   Copyright (C) 2005 Tomas Mecir <mecirt@gmail.com>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
 
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/
 
#ifndef KSPREAD_VALUECALC
#define KSPREAD_VALUECALC
 
#include <map>
 
#include <tqvaluelist.h>
#include <tqvaluevector.h>
 
#include "kspread_value.h"
 
namespace KSpread
{
class Doc;
class ValueCalc;
class ValueConverter;
 
// Condition structures
enum Comp { isEqual, isLess, isGreater, lessEqual, greaterEqual, notEqual };
enum Type { numeric, string };
 
struct Condition
{
  Comp     comp;
  int      index;
  double   value;
  TQString  stringValue;
  Type     type;
};
 
typedef TQValueList<Condition> ConditionList;
 
typedef void (*arrayWalkFunc) (ValueCalc *, Value &result,
    Value val, Value param);

 
class ValueCalc {
 public:
  ValueCalc (ValueConverter* c);
 
  ValueConverter *conv () { return converter; };
  
  // some functions need access to the document
  void setDoc (Doc *d) { _doc = d; };
  Doc *doc () { return _doc; };

  Value add (const Value &a, const Value &b);
  Value sub (const Value &a, const Value &b);
  Value mul (const Value &a, const Value &b);
  Value div (const Value &a, const Value &b);
  Value mod (const Value &a, const Value &b);
  Value pow (const Value &a, const Value &b);
  Value sqr (const Value &a);
  Value sqrt (const Value &a);
  Value add (const Value &a, double b);
  Value sub (const Value &a, double b);
  Value mul (const Value &a, double b);
  Value div (const Value &a, double b);
  Value pow (const Value &a, double b);
  Value abs (const Value &a);

  bool isZero (const Value &a);
  bool isEven (const Value &a);
  bool equal (const Value &a, const Value &b);
  bool approxEqual (const Value &a, const Value &b);
  bool greater (const Value &a, const Value &b);
  bool gequal (const Value &a, const Value &b);
  bool lower (const Value &a, const Value &b);
  bool strEqual (const Value &a, const Value &b, bool CS = true);
  bool strGreater (const Value &a, const Value &b, bool CS = true);
  bool strGequal (const Value &a, const Value &b, bool CS = true);
  bool strLower (const Value &a, const Value &b, bool CS = true);
  bool naturalEqual (const Value &a, const Value &b, bool CS = true);
  bool naturalGreater (const Value &a, const Value &b, bool CS = true);
  bool naturalGequal (const Value &a, const Value &b, bool CS = true);
  bool naturalLower (const Value &a, const Value &b, bool CS = true);
 
  int sign (const Value &a);

  Value roundDown (const Value &a, const Value &digits);
  Value roundUp (const Value &a, const Value &digits);
  Value round (const Value &a, const Value &digits);
  Value roundDown (const Value &a, int digits = 0);
  Value roundUp (const Value &a, int digits = 0);
  Value round (const Value &a, int digits = 0);
  
  Value log (const Value &number, const Value &base);
  Value log (const Value &number, double base = 10);
  Value ln (const Value &number);
  Value exp (const Value &number);

  Value pi ();
  Value eps ();
 
  Value random (double range = 1.0);
  Value random (Value range);
  
  Value fact (const Value &which);
  Value fact (const Value &which, const Value &end);
  Value fact (int which, int end = 0);
  Value factDouble (int which);
  Value factDouble (Value which);

  Value combin (int n, int k);
  Value combin (Value n, Value k);
  
  Value gcd (const Value &a, const Value &b);
  Value lcm (const Value &a, const Value &b);

  Value base (const Value &val, int base = 16, int prec = 0);
  Value fromBase (const Value &val, int base = 16);

  Value sin (const Value &number);
  Value cos (const Value &number);
  Value tg (const Value &number);
  Value cotg (const Value &number);
  Value asin (const Value &number);
  Value acos (const Value &number);
  Value atg (const Value &number);
  Value atan2 (const Value &y, const Value &x);

  Value sinh (const Value &number);
  Value cosh (const Value &number);
  Value tgh (const Value &number);
  Value asinh (const Value &number);
  Value acosh (const Value &number);
  Value atgh (const Value &number);

  Value phi (Value x);
  Value gauss (Value xx);
  Value gaussinv (Value xx);
  Value GetGamma (Value _x);
  Value GetLogGamma (Value _x);
  Value GetGammaDist (Value _x, Value _alpha,
    Value _beta);
  Value GetBeta (Value _x, Value _alpha,
    Value _beta);

  Value besseli (Value v, Value x);
  Value besselj (Value v, Value x);
  Value besselk (Value v, Value x);
  Value besseln (Value v, Value x);
  
  Value erf (Value x);
  Value erfc (Value x);
  
  void arrayWalk (const Value &range, Value &res,
      arrayWalkFunc func, Value param);
  void arrayWalk (TQValueVector<Value> &range, Value &res,
      arrayWalkFunc func, Value param);
  void twoArrayWalk (const Value &a1, const Value &a2,
      Value &res, arrayWalkFunc func);
  void twoArrayWalk (TQValueVector<Value> &a1,
      TQValueVector<Value> &a2, Value &res, arrayWalkFunc func);
  arrayWalkFunc awFunc (const TQString &name);
  void registerAwFunc (const TQString &name, arrayWalkFunc func);

  // if full is true, A-version is used (means string/bool values included)
  Value sum (const Value &range, bool full = true);
  Value sumsq (const Value &range, bool full = true);
  Value sumIf (const Value &range,
      const Value &checkRange, const Condition &cond);
  int count (const Value &range, bool full = true);
  int countIf (const Value &range, const Condition &cond);
  Value avg (const Value &range, bool full = true);
  Value max (const Value &range, bool full = true);
  Value min (const Value &range, bool full = true);
  Value product (const Value &range, Value init,
      bool full = true);
  Value stddev (const Value &range, bool full = true);
  Value stddev (const Value &range, Value avg,
      bool full = true);
  Value stddevP (const Value &range, bool full = true);
  Value stddevP (const Value &range, Value avg,
      bool full = true);
  
  Value sum (TQValueVector<Value> range, bool full = true);
  int count (TQValueVector<Value> range, bool full = true);
  Value avg (TQValueVector<Value> range, bool full = true);
  Value max (TQValueVector<Value> range, bool full = true);
  Value min (TQValueVector<Value> range, bool full = true);
  Value product (TQValueVector<Value> range, Value init,
      bool full = true);
  Value stddev (TQValueVector<Value> range, bool full = true);
  Value stddev (TQValueVector<Value> range, Value avg,
      bool full = true);
  Value stddevP (TQValueVector<Value> range, bool full = true);
  Value stddevP (TQValueVector<Value> range, Value avg,
      bool full = true);

  void getCond (Condition &cond, Value val);
  
  bool matches (const Condition &cond, Value d);
 
 protected:
  ValueConverter* converter;
  Value::Format format (Value::Format a, Value::Format b);
  
  Doc *_doc;
  
  std::map<TQString, arrayWalkFunc> awFuncs;
};
 
}  //namespace KSpread
 
 
#endif // KSPREAD_VALUECALC