-
-
Notifications
You must be signed in to change notification settings - Fork 630
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(constants): add float32 ln-ten constant
- Loading branch information
1 parent
a0ba090
commit f7b7464
Showing
10 changed files
with
486 additions
and
0 deletions.
There are no files selected for viewing
147 changes: 147 additions & 0 deletions
147
lib/node_modules/@stdlib/constants/float32/ln-ten/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,147 @@ | ||
<!-- | ||
@license Apache-2.0 | ||
Copyright (c) 2018 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. | ||
--> | ||
|
||
# FLOAT32_LN10 | ||
|
||
> [Natural logarithm][@stdlib/math/base/special/ln] of single-precision floating-point number `10`. | ||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
```javascript | ||
var FLOAT32_LN10 = require( '@stdlib/constants/float32/ln-ten' ); | ||
``` | ||
|
||
#### FLOAT32_LN10 | ||
|
||
[Natural logarithm][@stdlib/math/base/special/ln] of single-precision floating-point number `10`. | ||
|
||
```javascript | ||
var bool = ( FLOAT32_LN10 === 2.3025851249694824 ); | ||
// returns true | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<section class="examples"> | ||
|
||
## Examples | ||
|
||
<!-- TODO: better example --> | ||
|
||
<!-- eslint no-undef: "error" --> | ||
|
||
```javascript | ||
var FLOAT32_LN10 = require( '@stdlib/constants/float32/ln-ten' ); | ||
|
||
console.log( FLOAT32_LN10 ); | ||
// => 2.3025851249694824 | ||
``` | ||
|
||
</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/float32/ln_ten.h" | ||
``` | ||
|
||
#### STDLIB_CONSTANT_FLOAT32_LN10 | ||
|
||
Macro for the [natural logarithm][@stdlib/math/base/special/ln] of single-precision floating-point number `10`. | ||
|
||
</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"> | ||
|
||
* * * | ||
|
||
## See Also | ||
|
||
- <span class="package-name">[`@stdlib/constants/float32/ln-two`][@stdlib/constants/float32/ln-two]</span><span class="delimiter">: </span><span class="description">natural logarithm of single-precision floating-point number 2.</span> | ||
|
||
</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/ln]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ln | ||
|
||
<!-- <related-links> --> | ||
|
||
[@stdlib/constants/float32/ln-two]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/ln-two | ||
|
||
<!-- </related-links> --> | ||
|
||
</section> | ||
|
||
<!-- /.links --> |
12 changes: 12 additions & 0 deletions
12
lib/node_modules/@stdlib/constants/float32/ln-ten/docs/repl.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
|
||
{{alias}} | ||
Natural logarithm of single-precision floating-point number `10`. | ||
|
||
Examples | ||
-------- | ||
> {{alias}} | ||
2.3025851249694824 | ||
|
||
See Also | ||
-------- | ||
|
33 changes: 33 additions & 0 deletions
33
lib/node_modules/@stdlib/constants/float32/ln-ten/docs/types/index.d.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
/* | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2019 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 single-precision floating-point number `10`. | ||
* | ||
* @example | ||
* var val = FLOAT32_LN10; | ||
* // returns 2.3025851249694824 | ||
*/ | ||
declare const FLOAT32_LN10: number; | ||
|
||
|
||
// EXPORTS // | ||
|
||
export = FLOAT32_LN10; |
28 changes: 28 additions & 0 deletions
28
lib/node_modules/@stdlib/constants/float32/ln-ten/docs/types/test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
/* | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2019 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 FLOAT32_LN10 = require( './index' ); | ||
|
||
|
||
// TESTS // | ||
|
||
// The export is a number... | ||
{ | ||
// eslint-disable-next-line @typescript-eslint/no-unused-expressions | ||
FLOAT32_LN10; // $ExpectType number | ||
} |
24 changes: 24 additions & 0 deletions
24
lib/node_modules/@stdlib/constants/float32/ln-ten/examples/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2018 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 FLOAT32_LN10 = require( './../lib' ); | ||
|
||
console.log( FLOAT32_LN10 ); | ||
// => 2.3025851249694824 |
27 changes: 27 additions & 0 deletions
27
lib/node_modules/@stdlib/constants/float32/ln-ten/include/stdlib/constants/float32/ln_ten.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2022 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. | ||
*/ | ||
|
||
#ifndef STDLIB_CONSTANTS_FLOAT32_LN_TEN_H | ||
#define STDLIB_CONSTANTS_FLOAT32_LN_TEN_H | ||
|
||
/** | ||
* Macro for the natural logarithm of single-precision floating-point number 10. | ||
*/ | ||
#define STDLIB_CONSTANT_FLOAT32_LN10 2.3025851249694824f | ||
|
||
#endif // !STDLIB_CONSTANTS_FLOAT32_LN_TEN_H |
55 changes: 55 additions & 0 deletions
55
lib/node_modules/@stdlib/constants/float32/ln-ten/lib/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2018 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 single-precision floating-point number `10`. | ||
* | ||
* @module @stdlib/constants/float32/ln-ten | ||
* @type {number} | ||
* | ||
* @example | ||
* var LN10 = require( '@stdlib/constants/float32/ln-ten' ); | ||
* // returns 2.3025851249694824 | ||
*/ | ||
|
||
// MODULES // | ||
|
||
var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); | ||
|
||
|
||
// MAIN // | ||
|
||
/** | ||
* Natural logarithm of single-precision floating-point number `10`. | ||
* | ||
* ```tex | ||
* \ln 10 | ||
* ``` | ||
* | ||
* @constant | ||
* @type {number} | ||
* @default 2.3025851249694824 | ||
*/ | ||
var FLOAT32_LN10 = float64ToFloat32(2.30258509299404568401799145468436420760110148862877297603332790096757260967735248023599720508959829834196778404e+00); // eslint-disable-line max-len | ||
|
||
|
||
// EXPORTS // | ||
|
||
module.exports = FLOAT32_LN10; |
36 changes: 36 additions & 0 deletions
36
lib/node_modules/@stdlib/constants/float32/ln-ten/manifest.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
{ | ||
"options": {}, | ||
"fields": [ | ||
{ | ||
"field": "src", | ||
"resolve": true, | ||
"relative": true | ||
}, | ||
{ | ||
"field": "include", | ||
"resolve": true, | ||
"relative": true | ||
}, | ||
{ | ||
"field": "libraries", | ||
"resolve": false, | ||
"relative": false | ||
}, | ||
{ | ||
"field": "libpath", | ||
"resolve": true, | ||
"relative": false | ||
} | ||
], | ||
"confs": [ | ||
{ | ||
"src": [], | ||
"include": [ | ||
"./include" | ||
], | ||
"libraries": [], | ||
"libpath": [], | ||
"dependencies": [] | ||
} | ||
] | ||
} |
Oops, something went wrong.