From: Christian Bauer Date: Fri, 17 Oct 2003 00:29:59 +0000 (+0000) Subject: synced to 1.1 X-Git-Tag: release_1-2-0~81 X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=commitdiff_plain;h=3db194853d3dd2719231b83e4956cf6bcbe53627 synced to 1.1 --- diff --git a/ginac/archive.h b/ginac/archive.h index 5423dbfc..aa983f17 100644 --- a/ginac/archive.h +++ b/ginac/archive.h @@ -176,17 +176,20 @@ public: void archive_ex(const ex &e, const char *name); /** Retrieve expression from archive by name. - * @param sym_lst list of pre-defined symbols */ + * @param sym_lst list of pre-defined symbols + * @param name name of expression */ ex unarchive_ex(const lst &sym_lst, const char *name) const; /** Retrieve expression from archive by index. * @param sym_lst list of pre-defined symbols + * @param index index of expression * @see count_expressions */ ex unarchive_ex(const lst &sym_lst, unsigned index = 0) const; /** Retrieve expression and its name from archive by index. * @param sym_lst list of pre-defined symbols * @param name receives the name of the expression + * @param index index of expression * @see count_expressions */ ex unarchive_ex(const lst &sym_lst, std::string &name, unsigned index = 0) const; diff --git a/ginac/clifford.h b/ginac/clifford.h index f551abb7..d7770796 100644 --- a/ginac/clifford.h +++ b/ginac/clifford.h @@ -178,6 +178,7 @@ ex dirac_gammaR(unsigned char rl = 0); /** Create a term of the form e_mu * gamma~mu with a unique index mu. * + * @param e Original expression * @param dim Dimension of index * @param rl Representation label */ ex dirac_slash(const ex & e, const ex & dim, unsigned char rl = 0); diff --git a/ginac/matrix.cpp b/ginac/matrix.cpp index 9dc46de9..2c191ff4 100644 --- a/ginac/matrix.cpp +++ b/ginac/matrix.cpp @@ -938,6 +938,7 @@ matrix matrix::inverse() const * * @param vars n x p matrix, all elements must be symbols * @param rhs m x p matrix + * @param algo selects the solving algorithm * @return n x p solution matrix * @exception logic_error (incompatible matrices) * @exception invalid_argument (1st argument must be matrix of symbols) diff --git a/ginac/normal.cpp b/ginac/normal.cpp index 15982a03..9ff50b84 100644 --- a/ginac/normal.cpp +++ b/ginac/normal.cpp @@ -300,7 +300,6 @@ static ex multiply_lcm(const ex &e, const numeric &lcm) /** Compute the integer content (= GCD of all numeric coefficients) of an * expanded polynomial. * - * @param e expanded polynomial * @return integer content */ numeric ex::integer_content() const { @@ -1003,7 +1002,6 @@ static ex sr_gcd(const ex &a, const ex &b, sym_desc_vec::const_iterator var) /** Return maximum (absolute value) coefficient of a polynomial. * This function is used internally by heur_gcd(). * - * @param e expanded multivariate polynomial * @return maximum coefficient * @see heur_gcd */ numeric ex::max_coefficient() const @@ -1220,6 +1218,8 @@ static ex heur_gcd(const ex &a, const ex &b, ex *ca, ex *cb, sym_desc_vec::const * * @param a first multivariate polynomial * @param b second multivariate polynomial + * @param ca pointer to expression that will receive the cofactor of a, or NULL + * @param cb pointer to expression that will receive the cofactor of b, or NULL * @param check_args check whether a and b are polynomials with rational * coefficients (defaults to "true") * @return the GCD as a new expression */ @@ -1498,7 +1498,7 @@ static exvector sqrfree_yun(const ex &a, const symbol &x) /** Compute a square-free factorization of a multivariate polynomial in Q[X]. * * @param a multivariate polynomial over Q[X] - * @param x lst of variables to factor in, may be left empty for autodetection + * @param l lst of variables to factor in, may be left empty for autodetection * @return a square-free factorization of \p a. * * \note diff --git a/ginac/numeric.cpp b/ginac/numeric.cpp index f9c4a278..f8e4d93b 100644 --- a/ginac/numeric.cpp +++ b/ginac/numeric.cpp @@ -1287,14 +1287,14 @@ const numeric exp(const numeric &x) /** Natural logarithm. * - * @param z complex number + * @param x complex number * @return arbitrary precision numerical log(x). * @exception pole_error("log(): logarithmic pole",0) */ -const numeric log(const numeric &z) +const numeric log(const numeric &x) { - if (z.is_zero()) + if (x.is_zero()) throw pole_error("log(): logarithmic pole",0); - return cln::log(z.to_cl_N()); + return cln::log(x.to_cl_N()); } @@ -1345,8 +1345,8 @@ const numeric acos(const numeric &x) /** Arcustangent. * - * @param z complex number - * @return atan(z) + * @param x complex number + * @return atan(x) * @exception pole_error("atan(): logarithmic pole",0) */ const numeric atan(const numeric &x) { @@ -1927,16 +1927,16 @@ const numeric lcm(const numeric &a, const numeric &b) /** Numeric square root. - * If possible, sqrt(z) should respect squares of exact numbers, i.e. sqrt(4) + * If possible, sqrt(x) should respect squares of exact numbers, i.e. sqrt(4) * should return integer 2. * - * @param z numeric argument - * @return square root of z. Branch cut along negative real axis, the negative - * real axis itself where imag(z)==0 and real(z)<0 belongs to the upper part - * where imag(z)>0. */ -const numeric sqrt(const numeric &z) + * @param x numeric argument + * @return square root of x. Branch cut along negative real axis, the negative + * real axis itself where imag(x)==0 and real(x)<0 belongs to the upper part + * where imag(x)>0. */ +const numeric sqrt(const numeric &x) { - return cln::sqrt(z.to_cl_N()); + return cln::sqrt(x.to_cl_N()); }