]> www.ginac.de Git - ginac.git/commitdiff
Improved the comments explaining what the class ex does.
authorChris Dams <Chris.Dams@mi.infn.it>
Mon, 7 Aug 2006 16:51:24 +0000 (16:51 +0000)
committerChris Dams <Chris.Dams@mi.infn.it>
Mon, 7 Aug 2006 16:51:24 +0000 (16:51 +0000)
ginac/ex.h

index 498dbd664f7ae80d78aa3a1107aa5e3174891c82..8be4814e37b3644b06964a8b2cb981c0610674fc 100644 (file)
@@ -59,10 +59,11 @@ class const_preorder_iterator;
 class const_postorder_iterator;
 
 
-/** Lightweight wrapper for GiNaC's symbolic objects.  Basically all it does is
- *  to hold a pointer to the other objects, manage the reference counting and
- *  provide methods for manipulation of these objects.  (Some people call such
- *  a thing a proxy class.) */
+/** Lightweight wrapper for GiNaC's symbolic objects.  It holds a pointer to
+ *  the other object in order to do garbage collection by the method of
+ *  reference counting.  I.e., it is a smart pointer.  Also, the constructor
+ *  ex::ex(const basic & other) calls the methods that do automatic
+ *  evaluation.  E.g., x-x turns automatically into 0. */
 class ex {
        friend class archive_node;
        friend inline bool are_ex_trivially_equal(const ex &, const ex &);