Skip to content

Commit e5a5cff

Browse files
committed
Use UTF=8 so can get infinity symbol even in pure html.
Bump Dates and NEWS
1 parent f615ffe commit e5a5cff

3 files changed

Lines changed: 13 additions & 3 deletions

File tree

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Package: lamW
22
Type: Package
33
Title: Lambert-W Function
44
Version: 2.2.2
5-
Date: 2023-11-04
5+
Date: 2023-11-20
66
Authors@R: c(person(given="Avraham", family="Adler",role=c("aut", "cph", "cre"),
77
email="Avraham.Adler@gmail.com", comment = c(ORCID = "0000-0002-3039-0703")))
88
Description: Implements both real-valued branches of the Lambert-W function

inst/NEWS.Rd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@
66
\title{NEWS file for the lamW package}
77
\encoding{UTF-8}
88

9-
\section{Version 2.2.2 (2023-11-04)}{
9+
\section{Version 2.2.2 (2023-11-20)}{
1010
\subsection{Changed}{
1111
\itemize{
1212
\item \acronym{NEWS} was not rendering on \acronym{CRAN} because the file
1313
name used lowercase, \file{News.Rd}, and not \file{NEWS.Rd}.
14+
\item Tweaked documentation.
1415
}
1516
}
1617
}

man/lamW.Rd

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,24 @@
55
\alias{lambertW0}
66
\alias{lambertWm1}
77
\title{Lambert-W Function}
8+
\encoding{UTF-8}
9+
810
\description{
911
The Lambert-W function is defined as the multivalued inverse of the function
1012
\eqn{z = f(W) = We^W}{z = f(W) = W * exp(W)}. The function has two branches. The
1113
principal branch is defined on the interval
12-
\eqn{\left[-\frac{1}{e}, \infty\right)}{[-1/e, Infinity)} and is always greater
14+
\eqn{\left[-\frac{1}{e}, +\infty\right)}{[-1/e, +)} and is always greater
1315
than or equal to \eqn{-1}. The second branch is defined on the interval
1416
\eqn{\left[-\frac{1}{e}, 0\right)}{[-1/e, 0)} and is always less than or equal
1517
to \eqn{-1}. The real-valued function is not defined for values less than
1618
\eqn{-\frac{1}{e}}{-1/e}.
1719
}
20+
1821
\usage{
1922
lambertW0(x)
2023
lambertWm1(x)
2124
}
25+
2226
\arguments{
2327
\item{x}{\strong{numeric} vector of values}}
2428
\details{
@@ -35,12 +39,14 @@ simplifications. There are many applications in which the Lambert-W function is
3539
useful, such as combinatorics, physics, and hydrology. The interested reader is
3640
directed to the references for more detail.
3741
}
42+
3843
\value{
3944
Both functions return the appropriate values in the intervals for which they are
4045
defined. Outside of those intervals, they will return \code{NaN}, except that
4146
\code{lambertW0(Inf)} will return its limit \code{Inf} and \code{lambertWm1(0)}
4247
will return its limit -\code{Inf}.
4348
}
49+
4450
\references{
4551
Corless, R. M., Gonnet, G. H., Hare, D. E., Jeffrey, D. J., Knuth, D. E.
4652
1996 "On the Lambert W function", \emph{Advances in Computational Mathematics},
@@ -51,14 +57,17 @@ Fritsch, F. N.; Shafer, R. E. & Crowley, W. P.
5157
\emph{Communications of the ACM}, \bold{16}, 123--124,
5258
Association for Computing Machinery (ACM) <doi:10.1145/361952.361970>
5359
}
60+
5461
\author{
5562
Avraham Adler \email{Avraham.Adler@gmail.com}
5663
}
64+
5765
\seealso{
5866
This package provides similar functionality to the
5967
\code{\link[gsl:Lambert]{Lambert}} functions in the \pkg{gsl} package without
6068
having to obtain or install the entire \acronym{GSL}.
6169
}
70+
6271
\examples{
6372
lambertW0(exp(1)) ## Should equal 1, as 1 * exp(1) = e.
6473
lambertW0(0) ## Should equal 0, as 0 * exp(0) = 0.

0 commit comments

Comments
 (0)