- Doxygen'ed a bunch of comments.

[ginac.git] / ginac / constant.h

diff --git a/ginac/constant.h b/ginac/constant.h
index ef7e8c8d197a807c5f61928fa8a1c0d737831545..91ede2825ec395a59c131419c493915f90c791f0 100644 (file)
--- a/ginac/constant.h
+++ b/ginac/constant.h
@@ -2,50 +2,73 @@
  *
  *  Interface to GiNaC's constant types and some special constants. */
 
-#ifndef _CONSTANT_H_
-#define _CONSTANT_H_
+/*
+ *  GiNaC Copyright (C) 1999-2000 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
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program 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 General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
 
-#include <string>
+#ifndef __GINAC_CONSTANT_H__
+#define __GINAC_CONSTANT_H__
 
-class constant;
+#include <string>
+#include "basic.h"
 
-#include "ex.h"
-#include "numeric.h"
+#ifndef NO_NAMESPACE_GINAC
+namespace GiNaC {
+#endif // ndef NO_NAMESPACE_GINAC
 
+typedef ex (*evalffunctype)(void);
+    
 /** 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
 public:
+    constant();
     ~constant();
-    constant(constant const & other);
-    // constant const & operator=(constant const & other); /* it's pervert! */
+    constant(const constant & other);
+    // const constant & operator=(const constant & other); /* it's pervert! */
 protected:
-    void copy(constant const & other);
+    void copy(const constant & other);
     void destroy(bool call_parent);
 
     // other constructors
 public:
-    constant(string const & initname, ex (*efun)()=0);
-    constant(string const & initname, numeric const & initnumber);
+    constant(const string & initname, evalffunctype efun=0);
+    constant(const string & initname, const numeric & initnumber);
 
     // functions overriding virtual functions from bases classes
 public:
     basic * duplicate() const;
-    void printraw(ostream & os) 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;
 protected:
-    int compare_same_type(basic const & other) const;
-    bool is_equal_same_type(basic const & other) const;
+    ex derivative(const symbol & s) const;
+    int compare_same_type(const basic & other) const;
+    bool is_equal_same_type(const basic & other) const;
     
     // new virtual functions which can be overridden by derived classes
     // none
@@ -57,9 +80,9 @@ protected:
 
 private:
     string name;
-    ex (*ef)();
+    evalffunctype ef;
     numeric * number;
-    bool fct_assigned;
+    // bool fct_assigned;
     unsigned serial;  //!< unique serial number for comparision
     static unsigned next_serial;
 };
@@ -67,11 +90,15 @@ private:
 // global constants
 
 extern const constant some_constant;
-extern type_info const & typeid_constant;
+extern const type_info & typeid_constant;
 
 // extern const numeric I;
 extern const constant Pi;
 extern const constant Catalan;
 extern const constant EulerGamma;
 
-#endif // ndef _CONSTANT_H_
+#ifndef NO_NAMESPACE_GINAC
+} // namespace GiNaC
+#endif // ndef NO_NAMESPACE_GINAC
+
+#endif // ndef __GINAC_CONSTANT_H__