]> www.ginac.de Git - ginac.git/blobdiff - ginac/constant.h
implemented operator-> for the iterators
[ginac.git] / ginac / constant.h
index 99cbe99928506d55abaa6c5d49ddf266f9692b8d..f44ec9dcf08b30d356bf7d01e7198e53ca8fe2b3 100644 (file)
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's constant types and some special constants. */
 
 /*
- *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
 #define __GINAC_CONSTANT_H__
 
 #include <string>
-#include <ginac/basic.h>
+#include "basic.h"
+#include "ex.h"
 
-#ifndef NO_GINAC_NAMESPACE
 namespace GiNaC {
-#endif // ndef NO_GINAC_NAMESPACE
 
-typedef ex (*evalffunctype)(void);
-    
+typedef ex (*evalffunctype)();
+       
 /** This class holds constants, symbols with specific numerical value. Each
  *  object of this class must either provide their own function to evaluate it
  *  to class numeric or provide the constant as a numeric (if it's an exact
  *  number). */
 class constant : public basic
 {
-
+       GINAC_DECLARE_REGISTERED_CLASS(constant, basic)
+       
 // member functions
-
-    // default constructor, destructor, copy constructor assignment operator and helpers
+       
+       // other constructors
 public:
-    constant();
-    ~constant();
-    constant(constant const & other);
-    // constant const & operator=(constant const & other); /* it's pervert! */
-protected:
-    void copy(constant const & other);
-    void destroy(bool call_parent);
-
-    // other constructors
+       constant(const std::string & initname, evalffunctype efun = 0, const std::string & texname = std::string());
+       constant(const std::string & initname, const numeric & initnumber, const std::string & texname = std::string());
+       
+       // functions overriding virtual functions from base classes
 public:
-    constant(string const & initname, evalffunctype efun=0);
-    constant(string const & initname, numeric const & initnumber);
-
-    // functions overriding virtual functions from bases classes
-public:
-    basic * duplicate() const;
-    void print(ostream & os, unsigned upper_precedence=0) const;
-    void printraw(ostream & os) const;
-    void printtree(ostream & os, unsigned indent) const;
-    void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
-    ex evalf(int level=0) const;
-    ex diff(symbol const & s) const;
+       ex evalf(int level = 0) const;
 protected:
-    int compare_same_type(basic const & other) const;
-    bool is_equal_same_type(basic const & other) const;
-    
-    // new virtual functions which can be overridden by derived classes
-    // none
-
-    // non-virtual functions in this class
-    // none
+       ex derivative(const symbol & s) const;
+       bool is_equal_same_type(const basic & other) const;
+       unsigned calchash() const;
+       
+       // non-virtual functions in this class
+protected:
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_tree(const print_tree & c, unsigned level) const;
+       void do_print_latex(const print_latex & c, unsigned level) const;
+       void do_print_python_repr(const print_python_repr & c, unsigned level) const;
 
 // member variables
-
 private:
-    string name;
-    evalffunctype ef;
-    numeric * number;
-    // bool fct_assigned;
-    unsigned serial;  //!< unique serial number for comparision
-    static unsigned next_serial;
+       std::string name;     ///< printname of this constant
+       std::string TeX_name; ///< LaTeX name
+       evalffunctype ef;
+       ex number;            ///< numerical value this constant evalf()s to
+       unsigned serial;      ///< unique serial number for comparison
+       static unsigned next_serial;
 };
 
-// global constants
-
-extern const constant some_constant;
-extern type_info const & typeid_constant;
-
-// extern const numeric I;
 extern const constant Pi;
 extern const constant Catalan;
-extern const constant EulerGamma;
+extern const constant Euler;
+
+// utility functions
+
+/** Specialization of is_exactly_a<constant>(obj) for constant objects. */
+template<> inline bool is_exactly_a<constant>(const basic & obj)
+{
+       return obj.tinfo()==TINFO_constant;
+}
 
-#ifndef NO_GINAC_NAMESPACE
 } // namespace GiNaC
-#endif // ndef NO_GINAC_NAMESPACE
 
 #endif // ndef __GINAC_CONSTANT_H__