From: Chris Dams Date: Mon, 7 Aug 2006 16:50:21 +0000 (+0000) Subject: Improved the comments explaining what the class ex does. X-Git-Tag: release_1-4-0~76 X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=commitdiff_plain;h=f8cd4812fd1a238d85c183ac7c01a2ee9e7fd00b;ds=sidebyside Improved the comments explaining what the class ex does. --- diff --git a/ginac/ex.h b/ginac/ex.h index 60ffa129..574e6800 100644 --- a/ginac/ex.h +++ b/ginac/ex.h @@ -65,10 +65,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 &);