Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
@stdlib-bot
stdlib-bot committed Nov 20, 2023
1 parent b12f2f9 commit a34acbc
Show file tree
Hide file tree
Showing 3 changed files with 234 additions and 58 deletions.
112 changes: 54 additions & 58 deletions LICENSE
View file
Original file line number Diff line number Diff line change
Expand Up @@ -229,28 +229,39 @@ Permission to use, copy, modify, and distribute this
software is freely granted, provided that this notice
is preserved.

* Faddeeva <http://ab-initio.mit.edu/wiki/index.php/Faddeeva_Package#License>
* SLATEC Common Mathematical Library <http://www.netlib.no/netlib/slatec/>

Copyright (c) 2012 Massachusetts Institute of Technology
Public domain.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
* Go <https://raw.githubusercontent.com/golang/go/master/LICENSE>

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
Copyright (c) 2009 The Go Authors. All rights reserved.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

* SpecialFunctions.jl <https://raw.githubusercontent.com/JuliaMath/
SpecialFunctions.jl/02a173fbe24a61c4b392aec17a9764ac5727feb1/LICENSE>
Expand Down Expand Up @@ -283,52 +294,37 @@ SOFTWARE.

Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved.

* Go <https://raw.githubusercontent.com/golang/go/master/LICENSE>
* Faddeeva <http://ab-initio.mit.edu/wiki/index.php/Faddeeva_Package#License>

Copyright (c) 2009 The Go Authors. All rights reserved.
Copyright (c) 2012 Massachusetts Institute of Technology

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

* SLATEC Common Mathematical Library <http://www.netlib.no/netlib/slatec/>

Public domain.

151 changes: 151 additions & 0 deletions base/ops/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,19 @@
/* eslint-disable max-lines */

import add = require( './../../../../base/ops/add' );
import add3 = require( './../../../../base/ops/add3' );
import addf = require( './../../../../base/ops/addf' );
import cadd = require( './../../../../base/ops/cadd' );
import caddf = require( './../../../../base/ops/caddf' );
import cdiv = require( './../../../../base/ops/cdiv' );
import cmul = require( './../../../../base/ops/cmul' );
import cmulf = require( './../../../../base/ops/cmulf' );
import cneg = require( './../../../../base/ops/cneg' );
import cnegf = require( './../../../../base/ops/cnegf' );
import csub = require( './../../../../base/ops/csub' );
import csubf = require( './../../../../base/ops/csubf' );
import div = require( './../../../../base/ops/div' );
import divf = require( './../../../../base/ops/divf' );
import imul = require( './../../../../base/ops/imul' );
import imuldw = require( './../../../../base/ops/imuldw' );
import mul = require( './../../../../base/ops/mul' );
Expand Down Expand Up @@ -72,6 +76,36 @@ interface Namespace {
*/
add: typeof add;

/**
* Computes the sum of three double-precision floating-point numbers.
*
* @param x - first input value
* @param y - second input value
* @param z - third input value
* @returns sum
*
* @example
* var v = ns.add3( -1.0, 5.0, 2.0 );
* // returns 6.0
*
* @example
* var v = ns.add3( 2.0, 5.0, 2.0 );
* // returns 9.0
*
* @example
* var v = ns.add3( 0.0, 5.0, 2.0 );
* // returns 7.0
*
* @example
* var v = ns.add3( -0.0, 0.0, -0.0 );
* // returns 0.0
*
* @example
* var v = ns.add3( NaN, NaN, NaN );
* // returns NaN
*/
add3: typeof add3;

/**
* Computes the sum of two single-precision floating-point numbers `x` and `y`.
*
Expand Down Expand Up @@ -299,6 +333,65 @@ interface Namespace {
*/
cneg: typeof cneg;

/**
* Negates a single-precision complex floating-point number.
*
* @param z - complex number
* @returns result
*
* @example
* var Complex64 = require( `@stdlib/complex/float32` );
* var realf = require( `@stdlib/complex/realf` );
* var imagf = require( `@stdlib/complex/imagf` );
*
* var z = new Complex64( -4.2, 5.5 );
* // returns <Complex64>
*
* var out = ns.cnegf( z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns 4.2
*
* var im = imagf( out );
* // returns -5.5
*
* @example
* var Complex64 = require( `@stdlib/complex/float32` );
* var realf = require( `@stdlib/complex/realf` );
* var imagf = require( `@stdlib/complex/imagf` );
*
* var z = new Complex64( 0.0, 0.0 );
* // returns <Complex64>
*
* var out = ns.cnegf( z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns -0.0
*
* var im = imagf( out );
* // returns -0.0
*
* @example
* var Complex64 = require( `@stdlib/complex/float32` );
* var realf = require( `@stdlib/complex/realf` );
* var imagf = require( `@stdlib/complex/imagf` );
*
* var z = new Complex64( NaN, NaN );
* // returns <Complex64>
*
* var out = ns.cnegf( z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns NaN
*
* var im = imagf( out );
* // returns NaN
*/
cnegf: typeof cnegf;

/**
* Subtracts two double-precision complex floating-point numbers.
*
Expand Down Expand Up @@ -357,6 +450,64 @@ interface Namespace {
*/
csubf: typeof csubf;

/**
* Divides two double-precision floating-point numbers `x` and `y`.
*
* @param x - first input value (divided)
* @param y - second input value (divisor)
* @returns result
*
* @example
* var v = ns.div( -1.0, 5.0 );
* // returns -0.2
*
* @example
* var v = ns.div( 2.0, 5.0 );
* // returns 0.4
*
* @example
* var v = ns.div( 0.0, 5.0 );
* // returns 0.0
*
* @example
* var v = ns.div( -0.0, 5.0 );
* // returns -0.0
*
* @example
* var v = ns.div( NaN, NaN );
* // returns NaN
*/
div: typeof div;

/**
* Divides two single-precision floating-point numbers `x` and `y`.
*
* @param x - first input value (divided)
* @param y - second input value (divisor)
* @returns result
*
* @example
* var v = ns.divf( -1.0, 5.0 );
* // returns ~-0.2
*
* @example
* var v = ns.divf( 2.0, 5.0 );
* // returns ~0.4
*
* @example
* var v = ns.divf( 0.0, 5.0 );
* // returns 0.0
*
* @example
* var v = ns.divf( -0.0, 5.0 );
* // returns -0.0
*
* @example
* var v = ns.divf( NaN, NaN );
* // returns NaN
*/
divf: typeof divf;

/**
* Performs C-like multiplication of two signed 32-bit integers.
*
Expand Down
29 changes: 29 additions & 0 deletions base/special/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ import expit = require( './../../../../base/special/expit' );
import expm1 = require( './../../../../base/special/expm1' );
import expm1rel = require( './../../../../base/special/expm1rel' );
import factorial = require( './../../../../base/special/factorial' );
import factorial2 = require( './../../../../base/special/factorial2' );
import factorialln = require( './../../../../base/special/factorialln' );
import fallingFactorial = require( './../../../../base/special/falling-factorial' );
import fast = require( './../../../../base/special/fast' );
Expand Down Expand Up @@ -3031,6 +3032,34 @@ interface Namespace {
*/
factorial: typeof factorial;

/**
* Evaluates the double factorial of `n`.
*
* @param n - input value
* @returns double factorial
*
* @example
* var v = ns.factorial2( 3 );
* // returns 3
*
* @example
* var v = ns.factorial2( 4 );
* // returns 8
*
* @example
* var v = ns.factorial2( -10 );
* // returns NaN
*
* @example
* var v = ns.factorial2( 301 );
* // returns Infinity
*
* @example
* var v = ns.factorial2( NaN );
* // returns NaN
*/
factorial2: typeof factorial2;

/**
* Evaluates the natural logarithm of the factorial of `x`.
*
Expand Down

0 comments on commit a34acbc

Please sign in to comment.