Skip to content

Commit c7a61ab

Browse files
DivyanshuVortexDivyanshuVortex
authored
feat: add constants/float16/ln-half
PR-URL: stdlib-js#8971 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 075f9ca commit c7a61ab

File tree

8 files changed

+345
-0
lines changed

8 files changed

+345
-0
lines changed

‎lib/node_modules/@stdlib/constants/float16/ln-half/README.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 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+
# FLOAT16_LN_HALF
22+
23+
> Natural logarithm of `1/2` as a half-precision floating-point number.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var FLOAT16_LN_HALF = require( '@stdlib/constants/float16/ln-half' );
31+
```
32+
33+
#### FLOAT16_LN_HALF
34+
35+
Natural logarithm of `1/2` as a half-precision floating-point number.
36+
37+
```javascript
38+
var bool = ( FLOAT16_LN_HALF === -0.693359375 );
39+
// returns true
40+
```
41+
42+
</section>
43+
44+
<!-- /.usage -->
45+
46+
<section class="examples">
47+
48+
## Examples
49+
50+
<!-- TODO: better example -->
51+
52+
<!-- eslint no-undef: "error" -->
53+
54+
```javascript
55+
var FLOAT16_LN_HALF = require( '@stdlib/constants/float16/ln-half' );
56+
57+
console.log( FLOAT16_LN_HALF );
58+
// => -0.693359375
59+
```
60+
61+
</section>
62+
63+
</section>
64+
65+
<!-- /.related -->
66+
67+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
68+
69+
<section class="links">
70+
71+
</section>
72+
73+
<!-- /.links -->

‎lib/node_modules/@stdlib/constants/float16/ln-half/docs/repl.txt‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
{{alias}}
3+
Natural logarithm of `1/2` as a half-precision floating-point number.
4+
5+
Examples
6+
--------
7+
> {{alias}}
8+
-0.693359375
9+
10+
See Also
11+
--------
12+

‎lib/node_modules/@stdlib/constants/float16/ln-half/docs/types/index.d.ts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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+
// TypeScript Version: 4.1
20+
21+
/**
22+
* Natural logarithm of `1/2` as a half-precision floating-point number.
23+
*
24+
* @example
25+
* var val = FLOAT16_LN_HALF;
26+
* // returns -0.693359375
27+
*/
28+
declare const FLOAT16_LN_HALF: number;
29+
30+
31+
// EXPORTS //
32+
33+
export = FLOAT16_LN_HALF;

‎lib/node_modules/@stdlib/constants/float16/ln-half/docs/types/test.ts‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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+
import FLOAT16_LN_HALF = require( './index' );
20+
21+
22+
// TESTS //
23+
24+
// The export is a number...
25+
{
26+
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
27+
FLOAT16_LN_HALF; // $ExpectType number
28+
}

‎lib/node_modules/@stdlib/constants/float16/ln-half/examples/index.js‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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+
var FLOAT16_LN_HALF = require( './../lib' );
22+
23+
console.log( FLOAT16_LN_HALF );
24+
// => -0.693359375

‎lib/node_modules/@stdlib/constants/float16/ln-half/lib/index.js‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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+
/**
22+
* Natural logarithm of `1/2` as a half-precision floating-point number.
23+
*
24+
* @module @stdlib/constants/float16/ln-half
25+
* @type {number}
26+
*
27+
* @example
28+
* var FLOAT16_LN_HALF = require( '@stdlib/constants/float16/ln-half' );
29+
* // returns -0.693359375
30+
*/
31+
32+
// MAIN //
33+
34+
/**
35+
* Natural logarithm of `1/2` as a half-precision floating-point number.
36+
*
37+
* ```tex
38+
* \ln (1/2)
39+
* ```
40+
*
41+
* @constant
42+
* @type {number}
43+
* @default -0.693359375
44+
*/
45+
var FLOAT16_LN_HALF = -0.693359375;
46+
47+
48+
// EXPORTS //
49+
50+
module.exports = FLOAT16_LN_HALF;

‎lib/node_modules/@stdlib/constants/float16/ln-half/package.json‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
{
2+
"name": "@stdlib/constants/float16/ln-half",
3+
"version": "0.0.0",
4+
"description": "Natural logarithm of 1/2 as a half-precision floating-point number",
5+
"license": "Apache-2.0",
6+
"author": {
7+
"name": "The Stdlib Authors",
8+
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
9+
},
10+
"contributors": [
11+
{
12+
"name": "The Stdlib Authors",
13+
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
14+
}
15+
],
16+
"main": "./lib",
17+
"directories": {
18+
"doc": "./docs",
19+
"example": "./examples",
20+
"lib": "./lib",
21+
"test": "./test"
22+
},
23+
"types": "./docs/types",
24+
"scripts": {},
25+
"homepage": "https://github.com/stdlib-js/stdlib",
26+
"repository": {
27+
"type": "git",
28+
"url": "git://github.com/stdlib-js/stdlib.git"
29+
},
30+
"bugs": {
31+
"url": "https://github.com/stdlib-js/stdlib/issues"
32+
},
33+
"dependencies": {},
34+
"devDependencies": {},
35+
"engines": {
36+
"node": ">=0.10.0",
37+
"npm": ">2.7.0"
38+
},
39+
"os": [
40+
"aix",
41+
"darwin",
42+
"freebsd",
43+
"linux",
44+
"macos",
45+
"openbsd",
46+
"sunos",
47+
"win32",
48+
"windows"
49+
],
50+
"keywords": [
51+
"stdlib",
52+
"stdmath",
53+
"constant",
54+
"const",
55+
"mathematics",
56+
"math",
57+
"ln",
58+
"ln-half",
59+
"lnhalf",
60+
"natural",
61+
"logarithm",
62+
"log",
63+
"ieee754",
64+
"float",
65+
"single",
66+
"precision",
67+
"floating-point",
68+
"float16"
69+
]
70+
}

‎lib/node_modules/@stdlib/constants/float16/ln-half/test/test.js‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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 tape = require( 'tape' );
24+
var lnf = require( '@stdlib/math/base/special/lnf' );
25+
var absf = require( '@stdlib/math/base/special/absf' );
26+
var EPS = require( '@stdlib/constants/float16/eps' );
27+
var FLOAT16_LN_HALF = require( './../lib' );
28+
29+
30+
// TESTS //
31+
32+
tape( 'main export is a number', function test( t ) {
33+
t.ok( true, __filename );
34+
t.strictEqual( typeof FLOAT16_LN_HALF, 'number', 'main export is a number' );
35+
t.end();
36+
});
37+
38+
tape( 'export is a half-precision floating-point number equal to `-0.693359375`', function test( t ) {
39+
t.strictEqual( FLOAT16_LN_HALF, -0.693359375, 'returns expected value' );
40+
t.end();
41+
});
42+
43+
tape( 'export equals `lnf(0.5)`', function test( t ) {
44+
var delta;
45+
var tol;
46+
var v;
47+
48+
v = lnf( 0.5 );
49+
delta = absf( v - FLOAT16_LN_HALF );
50+
tol = EPS;
51+
52+
t.ok( delta <= tol, 'equals ln(0.5) within tolerance '+tol );
53+
54+
t.end();
55+
});

0 commit comments

Comments
 (0)