Auto-generated commit

CHANGELOG.md

@@ -10,6 +10,28 @@
 
 ### Packages
 
+<section class="package" id="constants-float32-e-unreleased">
+
+#### [@stdlib/constants/float32/e](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/e)
+
+<details>
+
+<section class="features">
+
+##### Features
+
+-   [`951fbd2`](https://github.com/stdlib-js/stdlib/commit/951fbd24ae17d11d75cb4a9c321ddc2e62eecd30) - add `constants/float32/e` [(#3101)](https://github.com/stdlib-js/stdlib/pull/3101)
+
+</section>
+
+<!-- /.features -->
+
+</details>
+
+</section>
+
+<!-- /.package -->
+
 <section class="package" id="constants-float32-ln-two-unreleased">
 
 #### [@stdlib/constants/float32/ln-two](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/ln-two)
@@ -124,6 +146,7 @@ A total of 3 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`951fbd2`](https://github.com/stdlib-js/stdlib/commit/951fbd24ae17d11d75cb4a9c321ddc2e62eecd30) - **feat:** add `constants/float32/e` [(#3101)](https://github.com/stdlib-js/stdlib/pull/3101) _(by Gururaj Gurram, Philipp Burckhardt)_
 -   [`824d519`](https://github.com/stdlib-js/stdlib/commit/824d5196406ebb5c9f73aedfd69d30fd6df0e2e0) - **feat:** add `constants/float32/min-base10-exponent` [(#3092)](https://github.com/stdlib-js/stdlib/pull/3092) _(by Gururaj Gurram, Philipp Burckhardt)_
 -   [`5c28ab7`](https://github.com/stdlib-js/stdlib/commit/5c28ab71e29097ff04c6c4de0038b4f6b733a68c) - **feat:** add `constants/float32/max-base10-exponent` [(#3091)](https://github.com/stdlib-js/stdlib/pull/3091) _(by Gururaj Gurram, Philipp Burckhardt)_
 -   [`893cb1b`](https://github.com/stdlib-js/stdlib/commit/893cb1b86ececb01085118705c19a842f70da511) - **feat:** add `constants/float32/ln-two` [(#3079)](https://github.com/stdlib-js/stdlib/pull/3079) _(by Gunj Joshi)_

float32/e/README.md

@@ -0,0 +1,135 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 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.
+
+-->
+
+# E
+
+> The mathematical constant [_e_][e].
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var E = require( '@stdlib/constants/float32/e' );
+```
+
+#### E
+
+The mathematical constant [_e_][e], also known as Euler's number or Napier's constant. [_e_][e] is the base of the natural logarithm.
+
+```javascript
+var bool = ( E === 2.7182817459106445 );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- TODO: better example -->
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var E = require( '@stdlib/constants/float32/e' );
+
+console.log( E );
+// => 2.7182817459106445
+```
+
+</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/e.h"
+```
+
+#### STDLIB_CONSTANT_FLOAT32_E
+
+Macro for Euler's number.
+
+</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">
+
+[e]: https://en.wikipedia.org/wiki/E_%28mathematical_constant%29
+
+</section>
+
+<!-- /.links -->

float32/e/docs/repl.txt

@@ -0,0 +1,12 @@
+
+{{alias}}
+    Euler's number.
+
+    Examples
+    --------
+    > {{alias}}
+    2.7182817459106445
+
+    See Also
+    --------
+

float32/e/docs/types/index.d.ts

@@ -0,0 +1,33 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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
+
+/**
+* Euler's number.
+*
+* @example
+* var e = E;
+* // returns 2.7182817459106445
+*/
+declare const E: number;
+
+
+// EXPORTS //
+
+export = E;

float32/e/docs/types/test.ts

@@ -0,0 +1,28 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 E = require( './index' );
+
+
+// TESTS //
+
+// The export is a number...
+{
+	// eslint-disable-next-line @typescript-eslint/no-unused-expressions
+	E; // $ExpectType number
+}

float32/e/examples/index.js

@@ -0,0 +1,24 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 E = require( './../lib' );
+
+console.log( E );
+// => 2.7182817459106445

float32/e/include/stdlib/constants/float32/e.h

@@ -0,0 +1,27 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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_E_H
+#define STDLIB_CONSTANTS_FLOAT32_E_H
+
+/**
+* Macro for Euler's number.
+*/
+#define STDLIB_CONSTANT_FLOAT32_E 2.718281828459045f
+
+#endif // !STDLIB_CONSTANTS_FLOAT32_E_H

float32/e/lib/index.js

@@ -0,0 +1,53 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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';
+
+/**
+* Euler's number.
+*
+* @module @stdlib/constants/float32/e
+* @type {number}
+*
+* @example
+* var E = require( '@stdlib/constants/float32/e' );
+* // returns 2.7182817459106445
+*/
+
+// MODULES //
+
+var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
+
+
+// MAIN //
+
+/**
+* Euler's number.
+*
+* @constant
+* @type {number}
+* @default 2.7182817459106445
+* @see [OEIS]{@link https://oeis.org/A001113}
+* @see [Wikipedia]{@link https://en.wikipedia.org/wiki/E_(mathematical_constant)}
+*/
+var E = float64ToFloat32( 2.718281828459045 );
+
+
+// EXPORTS //
+
+module.exports = E;

float32/e/manifest.json

@@ -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": []
+    }
+  ]
+}