add help in advance for new log2 and logn builtins

NOTE: The `log2(x [,eps])` and `logn(x, n [,eps])`
builtin functions are NOT yet implemented.
This commit is contained in:
Landon Curt Noll
2023-08-19 11:23:02 -07:00
parent ea57d2f24f
commit 5a117d542a
8 changed files with 173 additions and 21 deletions

View File

@@ -1,8 +1,10 @@
NAME
ilog - floor of logarithm to specified integer base
ilogn - floor of logarithm to specified integer base
SYNOPSIS
ilog(x, b)
ilogn(x, b)
TYPES
x nonzero real
@@ -13,10 +15,15 @@ TYPES
DESCRIPTION
Returns the greatest integer n for which b^n <= abs(x).
The ilogn function is an alias for ilog.
EXAMPLE
; print ilog(2, 3), ilog(8, 3), ilog(8.9, 3), ilog(1/8, 3)
0 1 1 -2
; print ilogn(2, 3), ilogn(8, 3), ilogn(8.9, 3), ilogn(1/8, 3)
0 1 1 -2
LIMITS
x > 0
b > 1
@@ -25,9 +32,9 @@ LINK LIBRARY
long zlog(ZVALUE x, ZVALUE b)
SEE ALSO
ilog2, ilog10
ilog10, ilog2, ln, log, log2, logn
## Copyright (C) 1999 Landon Curt Noll
## Copyright (C) 1999,2023 Landon Curt Noll
##
## Calc is open software; you can redistribute it and/or modify it under
## the terms of the version 2.1 of the GNU Lesser General Public License