Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 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
137 changes: 137 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/max-ln/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
<!--

@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_MAX_LN

> [Natural logarithm][natural-logarithm] of the maximum [half-precision floating-point number][ieee754].

<section class="usage">

## Usage

```javascript
var FLOAT16_MAX_LN = require( '@stdlib/constants/float16/max-ln' );
```

#### FLOAT16_MAX_LN

[Natural logarithm][natural-logarithm] of the maximum [half-precision floating-point number][ieee754].

```javascript
var bool = ( FLOAT16_MAX_LN === 11.09375 );
// returns true
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- TODO: better example -->

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

```javascript
var FLOAT16_MAX_LN = require( '@stdlib/constants/float16/max-ln' );

console.log( FLOAT16_MAX_LN );
// => 11.09375
```

</section>

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/constants/float16/max_ln.h"
Comment thread
kgryte marked this conversation as resolved.
Outdated
```

#### STDLIB_CONSTANT_FLOAT16_MAX_LN

Macro for the [natural logarithm][natural-logarithm] of the maximum [half-precision floating-point number][ieee754].

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- 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">

[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985

[natural-logarithm]: https://en.wikipedia.org/wiki/Natural_logarithm

</section>

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

{{alias}}
Natural logarithm of the maximum half-precision floating-point number.

Examples
--------
> {{alias}}
11.09375

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 the maximum half-precision floating-point number.
*
* @example
* var val = FLOAT16_MAX_LN;
* // returns 11.09375
*/
declare const FLOAT16_MAX_LN: number;


// EXPORTS //

export = FLOAT16_MAX_LN;
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_MAX_LN = require( './index' );


// TESTS //

// The export is a number...
{
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
FLOAT16_MAX_LN; // $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_MAX_LN = require( './../lib' );

console.log( FLOAT16_MAX_LN );
// => 11.09375
55 changes: 55 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/max-ln/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 the maximum half-precision floating-point number.
*
* @module @stdlib/constants/float16/max-ln
* @type {number}
*
* @example
* var FLOAT16_MAX_LN = require( '@stdlib/constants/float16/max-ln' );
* // returns 11.09375
*/

// MAIN //

/**
* Natural logarithm of the maximum half-precision floating-point number.
*
* ## Notes
*
* The natural logarithm of the maximum is given by
*
* ```tex
* \ln \left( 2^{15} (2 - 2^{-10}) \right)
* ```
*
* @constant
* @type {number}
* @default 11.09375
* @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985}
*/
var FLOAT16_MAX_LN = 11.09375;


// EXPORTS //

module.exports = FLOAT16_MAX_LN;
74 changes: 74 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/max-ln/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
{
"name": "@stdlib/constants/float16/max-ln",
"version": "0.0.0",
"description": "Natural logarithm of the maximum half-precision floating-point number.",
"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",
"include": "./include",
"lib": "./lib",
Comment thread
kgryte marked this conversation as resolved.
Outdated
"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",
"max",
"maximum",
"floating-point",
"float16",
"float",
"16bit",
"ieee754",
"flt",
"precision",
"largest",
"greatest",
"natural",
"logarithm",
"log",
"ln"
]
}
Loading
Loading