Skip to content

Commit 6c8f019

Browse files
gunjjoshiPlaneshifter
gunjjoshi
and
Planeshifter
authored
feat: add math/base/special/logf
PR-URL: #2809 Ref: #649 --------- Signed-off-by: Philipp Burckhardt <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 50b38f9 commit 6c8f019

File tree

24 files changed

+1843
-0
lines changed

24 files changed

+1843
-0
lines changed

‎lib/node_modules/@stdlib/math/base/special/logf/README.md

+198
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2024 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# Logarithm
22+
23+
> Compute the base `b` [logarithm][logarithm] of a single-precision floating-point number..
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var logf = require( '@stdlib/math/base/special/logf' );
31+
```
32+
33+
#### logf( x, b )
34+
35+
Computes the base `b` logarithm of a single-precision floating-point number.
36+
37+
```javascript
38+
var v = logf( 100.0, 10.0 );
39+
// returns 2.0
40+
41+
v = logf( 16.0, 2.0 );
42+
// returns 4.0
43+
44+
v = logf( 5.0, 1.0 );
45+
// returns Infinity
46+
```
47+
48+
For negative `x` or `b`, the [logarithm][logarithm] is **not** defined.
49+
50+
```javascript
51+
var v = logf( -4.0, 1.0 );
52+
// returns NaN
53+
54+
v = logf( 2.0, -4.0 );
55+
// returns NaN
56+
```
57+
58+
</section>
59+
60+
<!-- /.usage -->
61+
62+
<section class="examples">
63+
64+
## Examples
65+
66+
<!-- eslint no-undef: "error" -->
67+
68+
```javascript
69+
var randu = require( '@stdlib/random/base/randu' );
70+
var roundf = require( '@stdlib/math/base/special/roundf' );
71+
var logf = require( '@stdlib/math/base/special/logf' );
72+
73+
var b;
74+
var x;
75+
var i;
76+
77+
for ( i = 0; i < 100; i++ ) {
78+
x = roundf( randu() * 100.0 );
79+
b = roundf( randu() * 5.0 );
80+
console.log( 'logf( %d, %d ) = %d', x, b, logf( x, b ) );
81+
}
82+
```
83+
84+
</section>
85+
86+
<!-- /.examples -->
87+
88+
<!-- C interface documentation. -->
89+
90+
* * *
91+
92+
<section class="c">
93+
94+
## C APIs
95+
96+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
97+
98+
<section class="intro">
99+
100+
</section>
101+
102+
<!-- /.intro -->
103+
104+
<!-- C usage documentation. -->
105+
106+
<section class="usage">
107+
108+
### Usage
109+
110+
```c
111+
#include "stdlib/math/base/special/logf.h"
112+
```
113+
114+
#### stdlib_base_logf( x, b )
115+
116+
Computes the base `b` logarithm of a single-precision floating-point number.
117+
118+
```c
119+
float v = stdlib_base_logf( 100.0f, 10.0f );
120+
// returns 2.0f
121+
```
122+
123+
The function accepts the following arguments:
124+
125+
- **x**: `[in] float` input value.
126+
- **b**: `[in] float` input value.
127+
128+
```c
129+
float stdlib_base_logf( const float x, const float b );
130+
```
131+
132+
</section>
133+
134+
<!-- /.usage -->
135+
136+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
137+
138+
<section class="notes">
139+
140+
</section>
141+
142+
<!-- /.notes -->
143+
144+
<!-- C API usage examples. -->
145+
146+
<section class="examples">
147+
148+
### Examples
149+
150+
```c
151+
#include "stdlib/math/base/special/logf.h"
152+
#include <stdlib.h>
153+
#include <stdio.h>
154+
155+
int main( void ) {
156+
float out;
157+
float x;
158+
float b;
159+
int i;
160+
161+
for ( i = 0; i < 100; i++ ) {
162+
x = ( (float)rand() / (float)RAND_MAX ) * 100.0f;
163+
b = ( (float)rand() / (float)RAND_MAX ) * 5.0f;
164+
out = stdlib_base_logf( x, b );
165+
printf( "logf(%f, %f) = %f\n", x, b, out );
166+
}
167+
}
168+
```
169+
170+
</section>
171+
172+
<!-- /.examples -->
173+
174+
</section>
175+
176+
<!-- /.c -->
177+
178+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
179+
180+
<section class="related">
181+
182+
</section>
183+
184+
<!-- /.related -->
185+
186+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
187+
188+
<section class="links">
189+
190+
[logarithm]: https://en.wikipedia.org/wiki/Logarithm
191+
192+
<!-- <related-links> -->
193+
194+
<!-- </related-links> -->
195+
196+
</section>
197+
198+
<!-- /.links -->

‎lib/node_modules/@stdlib/math/base/special/logf/benchmark/benchmark.js

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var randu = require( '@stdlib/random/array/uniform' );
25+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
26+
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
27+
var pkg = require( './../package.json' ).name;
28+
var logf = require( './../lib' );
29+
30+
31+
// MAIN //
32+
33+
bench( pkg, function benchmark( b ) {
34+
var base;
35+
var x;
36+
var y;
37+
var i;
38+
39+
x = randu( 100, 1.0, 1000.0 );
40+
base = discreteUniform( 100, 2.0, 10.0 );
41+
42+
b.tic();
43+
for ( i = 0; i < b.iterations; i++ ) {
44+
y = logf( x[ i % x.length ], base[ i % base.length ] );
45+
if ( isnanf( y ) ) {
46+
b.fail( 'should not return NaN' );
47+
}
48+
}
49+
b.toc();
50+
if ( isnanf( y ) ) {
51+
b.fail( 'should not return NaN' );
52+
}
53+
b.pass( 'benchmark finished' );
54+
b.end();
55+
});

‎lib/node_modules/@stdlib/math/base/special/logf/benchmark/benchmark.native.js

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var resolve = require( 'path' ).resolve;
24+
var bench = require( '@stdlib/bench' );
25+
var randu = require( '@stdlib/random/array/uniform' );
26+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
27+
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
28+
var tryRequire = require( '@stdlib/utils/try-require' );
29+
var pkg = require( './../package.json' ).name;
30+
31+
32+
// VARIABLES //
33+
34+
var logf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
35+
var opts = {
36+
'skip': ( logf instanceof Error )
37+
};
38+
39+
40+
// MAIN //
41+
42+
bench( pkg+'::native', opts, function benchmark( b ) {
43+
var base;
44+
var x;
45+
var y;
46+
var i;
47+
48+
x = randu( 100, 1.0, 1000.0 );
49+
base = discreteUniform( 100, 2.0, 10.0 );
50+
51+
b.tic();
52+
for ( i = 0; i < b.iterations; i++ ) {
53+
y = logf( x[ i % x.length ], base[ i % base.length ] );
54+
if ( isnanf( y ) ) {
55+
b.fail( 'should not return NaN' );
56+
}
57+
}
58+
b.toc();
59+
if ( isnanf( y ) ) {
60+
b.fail( 'should not return NaN' );
61+
}
62+
b.pass( 'benchmark finished' );
63+
b.end();
64+
});

0 commit comments

Comments
 (0)