1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
/**
* @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.
*
*
* ## Notice
*
* The original C++ code and copyright notice are from the [Boost library]{@link http://www.boost.org/doc/libs/1_65_0/boost/math/special_functions/detail/polygamma.hpp}. The implementation follows the original but has been modified for JavaScript.
*
* ```text
* (C) Copyright Nikhar Agrawal 2013.
* (C) Copyright Christopher Kormanyos 2013.
* (C) Copyright John Maddock 2014.
* (C) Copyright Paul Bristow 2013.
*
* Use, modification and distribution are subject to the
* Boost Software License, Version 1.0. (See accompanying file
* LICENSE or copy at http://www.boost.org/LICENSE_1_0.txt)
* ```
*/
'use strict';
// MODULES //
var logger = require( 'debug' );
var isNonNegativeInteger = require( './../../../../base/assert/is-nonnegative-integer' );
var factorial = require( './../../../../base/special/factorial' );
var trigamma = require( './../../../../base/special/trigamma' );
var digamma = require( './../../../../base/special/digamma' );
var signum = require( './../../../../base/special/signum' );
var ldexp = require( './../../../../base/special/ldexp' );
var floor = require( './../../../../base/special/floor' );
var trunc = require( './../../../../base/special/trunc' );
var zeta = require( './../../../../base/special/riemann-zeta' );
var abs = require( './../../../../base/special/abs' );
var min = require( './../../../../base/special/min' );
var PINF = require( '@stdlib/constants/float64/pinf' );
var NINF = require( '@stdlib/constants/float64/ninf' );
var MAX = require( '@stdlib/constants/float64/max' );
var PI = require( '@stdlib/constants/float64/pi' );
var attransitionplus = require( './attransitionplus.js' );
var atinfinityplus = require( './atinfinityplus.js' );
var polycotpi = require( './polycotpi.js' );
var nearzero = require( './nearzero.js' );
// VARIABLES //
var debug = logger( 'polygamma' );
var DIGITS_BASE10 = 19;
// MAIN //
/**
* Evaluates the polygamma function.
*
* @param {NonNegativeInteger} n - order of derivative
* @param {number} x - input value
* @returns {number} (n+1)'th derivative
*
* @example
* var v = polygamma( 3, 1.2 );
* // returns ~3.245
*
* @example
* var v = polygamma( 5, 1.2 );
* // returns ~41.39
*
* @example
* var v = polygamma( 3, -4.9 );
* // returns ~60014.239
*
* @example
* var v = polygamma( 2.5, -1.2 );
* // returns NaN
*
* @example
* var v = polygamma( -1, 5.3 );
* // returns NaN
*
* @example
* var v = polygamma( 2, -2.0 );
* // returns NaN
*
* @example
* var v = polygamma( NaN, 2.1 );
* // returns NaN
*
* @example
* var v = polygamma( 1, NaN );
* // returns NaN
*
* @example
* var v = polygamma( NaN, NaN );
* // returns NaN
*/
function polygamma( n, x ) {
var xSmallLimit;
var result;
var z;
if ( !isNonNegativeInteger( n ) ) {
return NaN;
}
if ( n === 0 ) {
return digamma( x );
}
if ( n === 1 ) {
return trigamma( x );
}
if ( x < 0.0 ) {
if ( floor(x) === x ) {
// Result is infinity if `x` is odd, and a pole error if `x` is even.
if ( trunc( x ) & 1 ) {
return PINF;
}
debug( 'Evaluation at negative integer: %d.', x );
return NaN;
}
z = 1.0 - x;
result = polygamma( n, z ) + ( PI * polycotpi( n, z, x ) );
return ( n & 1 ) ? -result : result;
}
// Limit for use of small-x series is chosen so that the series doesn't go too divergent in the first few terms. Ordinarily, this would mean setting the limit to `~1/n`, but we can tolerate a small amount of divergence:
xSmallLimit = min( 5.0/n, 0.25 );
if ( x < xSmallLimit ) {
return nearzero( n, x );
}
if ( x > ( 0.4 * DIGITS_BASE10 ) + ( 4*n ) ) {
return atinfinityplus( n, x );
}
if ( x === 1.0 ) {
return ( ( n & 1 ) ? 1.0 : -1.0 ) * factorial( n ) * zeta( n+1 );
}
if ( x === 0.5 ) {
result = ( ( n & 1 ) ? 1.0 : -1.0 ) * factorial( n ) * zeta( n+1 );
if ( abs( result ) >= ldexp( MAX, -n-1 ) ) {
return ( signum( result ) === 1 ) ? PINF : NINF;
}
result *= ldexp( 1.0, n+1 ) - 1.0;
return result;
}
return attransitionplus( n, x );
}
// EXPORTS //
module.exports = polygamma;
|
