From 3e1261de1b7d8356e1295bc02e22dbd591c79cd1 Mon Sep 17 00:00:00 2001 From: Christian Bauer Date: Thu, 18 Nov 1999 20:47:27 +0000 Subject: [PATCH] - added documentation to ex_to_series() and series_to_poly() --- ginac/series.h | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/ginac/series.h b/ginac/series.h index 7b4e095f..5df4d822 100644 --- a/ginac/series.h +++ b/ginac/series.h @@ -88,12 +88,26 @@ protected: extern const series some_series; extern type_info const & typeid_series; -// utility functions +/** Return a reference to the series object embedded in an expression. + * The result is undefined if the expression does not contain a series + * object at its top level. + * + * @param e expression + * @return reference to series object + * @see is_ex_of_type */ inline const series &ex_to_series(const ex &e) { return static_cast(*e.bp); } +/** Convert the series object embedded in an expression to an ordinary + * polynomial in the expansion variable. The result is undefined if the + * expression does not contain a series object at its top level. + * + * @param e expression + * @return polynomial expression + * @see is_ex_of_type + * @see series::convert_to_poly */ inline ex series_to_poly(const ex &e) { return (static_cast(*e.bp).convert_to_poly(true)); -- 2.44.0