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
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
<!--

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

> Maximum nth [double factorial][double-factorial] when stored in [half-precision floating-point][ieee754] format.

<section class="usage">

## Usage

<!-- eslint-disable id-length -->

```javascript
var FLOAT16_MAX_NTH_DOUBLE_FACTORIAL = require( '@stdlib/constants/float16/max-nth-double-factorial' );
```

#### FLOAT16_MAX_NTH_DOUBLE_FACTORIAL

The maximum nth [double factorial][double-factorial] when stored in [half-precision floating-point][ieee754] format.

<!-- eslint-disable id-length -->

```javascript
var bool = ( FLOAT16_MAX_NTH_DOUBLE_FACTORIAL === 12 );
// returns true
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- eslint-disable id-length -->

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

```javascript
var FLOAT16_MAX_NTH_DOUBLE_FACTORIAL = require( '@stdlib/constants/float16/max-nth-double-factorial' );

function factorial2( n ) {
var a;
var i;

a = 1;
for ( i = n; i >= 2; i -= 2 ) {
a *= i;
}
return a;
}

var v;
var i;
for ( i = 0; i < 100; i++ ) {
v = factorial2( i );
if ( i > FLOAT16_MAX_NTH_DOUBLE_FACTORIAL ) {
console.log( 'Overflow: %d', v );
} else {
console.log( 'Valid: %d', v );
}
}
```

</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_nth_double_factorial.h"
```

#### STDLIB_CONSTANT_FLOAT16_MAX_NTH_DOUBLE_FACTORIAL

Macro for the maximum nth [double factorial][double-factorial] when stored in [half-precision floating-point][ieee754] format.

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

[double-factorial]: https://en.wikipedia.org/wiki/Double_factorial

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

<!-- <related-links> -->

<!-- </related-links> -->

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

{{alias}}
Maximum nth double factorial when stored in half-precision floating-point
format.

Examples
--------
> {{alias}}
12

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

/**
* Maximum nth double factorial when stored in half-precision floating-point format.
*
* @example
* var max = FLOAT16_MAX_NTH_DOUBLE_FACTORIAL;
* // returns 12
*/
declare const FLOAT16_MAX_NTH_DOUBLE_FACTORIAL: number;


// EXPORTS //

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


// TESTS //

// The export is a number...
{
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
FLOAT16_MAX_NTH_DOUBLE_FACTORIAL; // $ExpectType number
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/**
* @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_NTH_DOUBLE_FACTORIAL = require( './../lib' ); // eslint-disable-line id-length

function factorial2( n ) {
var a;
var i;

a = 1;
for ( i = n; i >= 2; i -= 2 ) {
a *= i;
}
return a;
}

var v;
var i;
for ( i = 0; i < 100; i++ ) {
v = factorial2( i );
if ( i > FLOAT16_MAX_NTH_DOUBLE_FACTORIAL ) {
console.log( 'Overflow: %d', v );
} else {
console.log( 'Valid: %d', v );
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/**
* @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.
*/

#ifndef STDLIB_CONSTANTS_FLOAT16_MAX_NTH_DOUBLE_FACTORIAL_H
#define STDLIB_CONSTANTS_FLOAT16_MAX_NTH_DOUBLE_FACTORIAL_H

/**
* Macro for the maximum nth double factorial when stored in half-precision floating-point format.
*/
#define STDLIB_CONSTANT_FLOAT16_MAX_NTH_DOUBLE_FACTORIAL 12

#endif // !STDLIB_CONSTANTS_FLOAT16_MAX_NTH_DOUBLE_FACTORIAL_H
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
/**
* @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.
*/

/* eslint-disable id-length */

'use strict';

/**
* Maximum nth double factorial when stored in half-precision floating-point format.
*
* @module @stdlib/constants/float16/max-nth-double-factorial
* @type {integer32}
*
* @example
* var FLOAT16_MAX_NTH_DOUBLE_FACTORIAL = require( '@stdlib/constants/float16/max-nth-double-factorial' );
* // returns 12
*/


// MAIN //

/**
* The maximum nth double factorial when stored in half-precision floating-point format.
*
* @constant
* @type {integer32}
* @default 12
* @see [double factorial]{@link https://en.wikipedia.org/wiki/Double_factorial}
* @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985}
*/
var FLOAT16_MAX_NTH_DOUBLE_FACTORIAL = 12|0; // asm type annotation


// EXPORTS //

module.exports = FLOAT16_MAX_NTH_DOUBLE_FACTORIAL;
Loading