Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 89 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/ln-two-pi/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<!--

@license Apache-2.0

Copyright (c) 2025 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->

# FLOAT16_LN_TWO_PI

> [Natural logarithm][@stdlib/math/base/special/lnf] of `2π`.

<section class="usage">

## Usage

```javascript
var FLOAT16_LN_TWO_PI = require( '@stdlib/constants/float16/ln-two-pi' );
```

#### FLOAT16_LN_TWO_PI

[Natural logarithm][@stdlib/math/base/special/lnf] of `2π`.

```javascript
var bool = ( FLOAT16_LN_TWO_PI === 1.8369140625 );
// returns true
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- TODO: better example -->

<!-- eslint no-undef: "error" -->

```javascript
var FLOAT16_LN_TWO_PI = require( '@stdlib/constants/float16/ln-two-pi' );

console.log( FLOAT16_LN_TWO_PI );
// => 1.8369140625
```

</section>

<!-- /.examples -->

<section class="examples">

</section>

<!-- /.examples -->

</section>

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[@stdlib/math/base/special/lnf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/lnf

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/ln-two-pi/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

{{alias}}
Natural logarithm of `2π`.

Examples
--------
> {{alias}}
1.8369140625

See Also
--------

Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// TypeScript Version: 4.1

/**
* Natural logarithm of `2π`.
*
* @example
* var val = FLOAT16_LN_TWO_PI;
* // returns 1.8369140625
*/
declare const FLOAT16_LN_TWO_PI: number;


// EXPORTS //

export = FLOAT16_LN_TWO_PI;
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import FLOAT16_LN_TWO_PI = require( './index' );


// TESTS //

// The export is a number...
{
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
FLOAT16_LN_TWO_PI; // $ExpectType number
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

var FLOAT16_LN_TWO_PI = require( './../lib' );

console.log( FLOAT16_LN_TWO_PI );
// => 1.8369140625
55 changes: 55 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/ln-two-pi/lib/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

/**
* Natural logarithm of `2π`.
*
* @module @stdlib/constants/float16/ln-two-pi
* @type {number}
*
* @example
* var FLOAT16_LN_TWO_PI = require( '@stdlib/constants/float16/ln-two-pi' );
* // returns 1.8369140625
*/

// MODULES //

// (removed conversion import; not needed for hardcoded float16 value)


// MAIN //

/**
* Natural logarithm of `2π`.
*
* ```tex
* \ln 2\pi
* ```
*
* @constant
* @type {number}
* @default 1.8369140625
*/
var FLOAT16_LN_TWO_PI = 1.8369140625;


// EXPORTS //

module.exports = FLOAT16_LN_TWO_PI;
71 changes: 71 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/ln-two-pi/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
{
"name": "@stdlib/constants/float16/ln-two-pi",
"version": "0.0.0",
"description": "Natural logarithm of 2π.",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
},
"contributors": [
{
"name": "The Stdlib Authors",
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
}
],
"main": "./lib",
"directories": {
"doc": "./docs",
"example": "./examples",
"lib": "./lib",
"test": "./test"
},
"types": "./docs/types",
"scripts": {},
"homepage": "https://github.com/stdlib-js/stdlib",
"repository": {
"type": "git",
"url": "git://github.com/stdlib-js/stdlib.git"
},
"bugs": {
"url": "https://github.com/stdlib-js/stdlib/issues"
},
"dependencies": {},
"devDependencies": {},
"engines": {
"node": ">=0.10.0",
"npm": ">2.7.0"
},
"os": [
"aix",
"darwin",
"freebsd",
"linux",
"macos",
"openbsd",
"sunos",
"win32",
"windows"
],
"keywords": [
"stdlib",
"stdmath",
"constant",
"const",
"mathematics",
"math",
"ln",
"ln2",
"math.ln2",
"natural",
"logarithm",
"log",
"ieee754",
"precision",
"floating-point",
"float",
"float16",
"pi",
"2pi"
]
}
56 changes: 56 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/ln-two-pi/test/test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var tape = require( 'tape' );
var lnf = require( '@stdlib/math/base/special/lnf' );
var absf = require( '@stdlib/math/base/special/absf' );
var EPS = require( '@stdlib/constants/float16/eps' );
var PI = require( '@stdlib/constants/float16/pi' );
var FLOAT16_LN_TWO_PI = require( './../lib' );


// TESTS //

tape( 'main export is a number', function test( t ) {
t.ok( true, __filename );
t.strictEqual( typeof FLOAT16_LN_TWO_PI, 'number', 'main export is a number' );
t.end();
});

tape( 'export is a half-precision floating-point number equal to `1.8369140625`', function test( t ) {
t.strictEqual( FLOAT16_LN_TWO_PI, 1.8369140625, 'returns expected value' );
t.end();
});

tape( 'export equals `ln(2*pi)`', function test( t ) {
var delta;
var tol;
var v;

v = lnf( 2.0*PI );
delta = absf( v - FLOAT16_LN_TWO_PI );
tol = EPS * FLOAT16_LN_TWO_PI;

t.ok( delta <= tol, 'equals ln(2*pi) within tolerance '+tol );

t.end();
});