~dieggsy/numchi

8e0044908ba9386b0f199f6039156cfdbe285a84 — dieggsy 1 year, 10 months ago 3d8093f
Add explicit documentation for mathh-constants, don't double export
1 files changed, 43 insertions(+), 4 deletions(-)

M constants.scm
M constants.scm => constants.scm +43 -4
@@ 3,14 3,53 @@
 ninf
 nan
 nzero
 e
 euler-gamma
 pi)
 euler-gamma)
(define inf @("An alias for +inf.0") +inf.0)
(define ninf @("An alias for -inf.0") -inf.0)
(define nan @("An alias for +nan.0") +nan.0)
(define nzero @("An alias for -0.0") -0.0)
(define euler-gamma @("Euler-Mascheroni constant") 0.5772156649015328606065120900824024310422)

@("In addition to the above, numchi reexports all constants from
@("<constant>e</constant>
<constant>1/e</constant>
<constant>e^2</constant>
<constant>e^pi/4</constant>
<constant>log2e</constant>
<constant>log10e</constant>
<constant>ln2</constant>
<constant>ln3</constant>
<constant>lnpi</constant>
<constant>ln10</constant>
<constant>1/ln2</constant>
<constant>1/ln10</constant>
<constant>pi</constant>
<constant>pi/2</constant>
<constant>pi/4</constant>
<constant>1/pi</constant>
<constant>2/pi</constant>
<constant>2/sqrtpi</constant>
<constant>sqrtpi</constant>
<constant>pi^2</constant>
<constant>degree</constant>
<constant>sqrt2</constant>
<constant>1/sqrt2</constant>
<constant>sqrt3</constant>
<constant>sqrt5</constant>
<constant>sqrt10</constant>
<constant>cubert2</constant>
<constant>cubert3</constant>
<constant>4thrt2</constant>
<constant>gamma1/2</constant>
<constant>gamma1/3</constant>
<constant>gamma2/3</constant>
<constant>phi</constant>
<constant>lnphi</constant>
<constant>1/lnphi</constant>
<constant>euler</constant>
<constant>e^euler</constant>
<constant>sin1</constant>
<constant>cos1</constant>
<constant>zeta3</constant>")

@("Constants reexported from
[[https://wiki.call-cc.org/eggref/5/mathh#math-constants-module|mathh-consts]].")