Merge zizzer:/bk/m5 into zower.eecs.umich.edu:/z/hsul/bk/clean

--HG--
extra : convert_revision : 112a99bde10ea9c56f2390389dd13c024e298331
This commit is contained in:
Lisa Hsu 2003-10-21 23:18:07 -04:00
commit a7c88ad2ae

View file

@ -2578,12 +2578,20 @@ class Formula : public Detail::VectorStat
} }
/** /**
* Return the vector of values of this formula. * Return the result of the Fomula in a vector. If there were no Vector
* components to the Formula, then the vector is size 1. If there were,
* like x/y with x being a vector of size 3, then the result returned will
* be x[0]/y, x[1]/y, x[2]/y, respectively.
* @return The result vector. * @return The result vector.
*/ */
const rvec_t &val() const { return root->val(); } const rvec_t &val() const { return root->val(); }
/** /**
* Return the total of the result vector. * Return the total Formula result. If there is a Vector component to this
* Formula, then this is the result of the Formula if the formula is applied
* after summing all the components of the Vector. For example, if Formula
* is x/y where x is size 3, then total() will return (x[1]+x[2]+x[3])/y. If there is no
* Vector component, total() returns the same value as the first entry in the rvec_t
* val() returns.
* @return The total of the result vector. * @return The total of the result vector.
*/ */
result_t total() const { return root->total(); } result_t total() const { return root->total(); }