- rotate_31() and golden_hash_ratio() moved to utils.h

[ginac.git] / ginac / series.h

diff --git a/ginac/series.h b/ginac/series.h
index e0fe511fbec3345a7cb704db40cfc0bfcf575290..5df4d82214d0d68e4b001ebdbcf8c737b95fc178 100644 (file)
--- a/ginac/series.h
+++ b/ginac/series.h
@@ -1,7 +1,8 @@
 /** @file series.h
  *
- *  Interface to class for extended truncated power series.
- *
+ *  Interface to class for extended truncated power series. */
+
+/*
  *  GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
  *
  *  This program is free software; you can redistribute it and/or modify
@@ -22,6 +23,11 @@
 #ifndef __GINAC_SERIES_H__
 #define __GINAC_SERIES_H__
 
+#include <ginac/basic.h>
+#include <ginac/expairseq.h>
+
+namespace GiNaC {
+
 /** This class holds a extended truncated power series (positive and negative
  *  integer powers). It consists of expression coefficients (only non-zero
  *  coefficients are stored), an expansion variable and an expansion point.
@@ -82,7 +88,31 @@ protected:
 extern const series some_series;
 extern type_info const & typeid_series;
 
-#define ex_to_series(X) (static_cast<class series const &>(*(X).bp))
-#define series_to_poly(X) (static_cast<series const &>(*(X).bp).convert_to_poly(true))
+/** 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<const series &>(*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<const series &>(*e.bp).convert_to_poly(true));
+}
+
+} // namespace GiNaC
 
 #endif // ndef __GINAC_SERIES_H__