Changeset 3533 in Sophya for trunk/SophyaLib/Samba/lambdaBuilder.cc

Timestamp:

Oct 12, 2008, 7:11:59 PM (17 years ago)

Author:

ansari

Message:

Adapation suite suppression flag OS_MACOSX, OS_LINUX + modifs cosmetiques lambdaBuilder.h .cc Reza 12/10/2008

File:

• trunk/SophyaLib/Samba/lambdaBuilder.cc (modified) (2 diffs)

trunk/SophyaLib/Samba/lambdaBuilder.cc

@@ -6 +6 @@
 /*!
   \class SOPHYA::Legendre
-generate Legendre polynomials : use in two steps : 
-
-a) instanciate Legendre(\f$x\f$, \f$lmax\f$) ; \f$x\f$ is the value for wich Legendre polynomials will be required (usually equal to \f$\cos \theta\f$) and \f$lmax\f$ is the MAXIMUM value of the order of polynomials wich will be required in the following code (all polynomials, from \f$l=0 to lmax\f$, are computed once for all by an iterative formula).
-
-b) get the value of Legendre polynomial for a particular value of \f$l\f$ by calling the method getPl.
-
-*/
-
-
+  \ingroup Samba
+
+ Generate Legendre polynomials. The class usage can be summarized  in two steps as follows:
+
+  a) instanciate Legendre(\f$x\f$, \f$lmax\f$) ; \f$x\f$ is the value for wich Legendre 
+  polynomials will be required (usually equal to \f$\cos \theta\f$) and \f$lmax\f$ is 
+  the MAXIMUM value of the order of polynomials wich will be required. 
+  (All polynomials, from \f$l=0 to lmax\f$, are computed once for all by an recursive formula).
+
+  b) get the value of Legendre polynomial for a particular value of \f$l\f$ by calling the 
+  method getPl.
+
+*/
+
+/*! Constructor, with specification of \b lmax and the \b x value for the polynomials */
 Legendre::Legendre(r_8 x, int_4 lmax) 
 {
-  if (fabs(x) > 1. ) 
-    {
-      throw RangeCheckError("variable for Legendre polynomials must have modules inferior to 1" );
-    }
+  if (fabs(x) > 1. ) {
+    throw RangeCheckError("Legendre::Legendre(x,lmax)  invalid x argument, fabs(x) > 1 !" );
+  }
   x_ = x;
   array_init(lmax);
 }
    
-/*! \fn void SOPHYA::Legendre::array_init(int_4 lmax)
-
-compute all \f$P_l(x,l_{max})\f$ for \f$l=1,l_{max}\f$ 
-*/
+/*! Private method which computes all \f$P_l(x,l_{max})\f$ for \f$l=1,l_{max}\f$ */
 void Legendre::array_init(int_4 lmax)
 {
@@ -35 +37 @@
   Pl_(0)=1.;
   if (lmax>0) Pl_(1)=x_;
-  for (int k=2; k<Pl_.NElts(); k++)
-    {
+  for (int k=2; k<Pl_.NElts(); k++) {
       Pl_(k) = ( (2.*k-1)*x_*Pl_(k-1)-(k-1)*Pl_(k-2) )/k;
-    }
+  }
 }