Skip to content

Commit 55c6ebf

Browse files
Neerajpathak07Neerajpathak07
committed
feat: add-betainc
1 parent 6a2b590 commit 55c6ebf

File tree

15 files changed

+1386
-0
lines changed

15 files changed

+1386
-0
lines changed

‎lib/node_modules/@stdlib/math/base/special/betainc/LICENSE‎

Lines changed: 215 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,215 @@
1+
file line number Original file line Diff line number Diff line change
2+
@@ -0,0 +1,213 @@
3+
4+
Apache License
5+
Version 2.0, January 2004
6+
http://www.apache.org/licenses/
7+
8+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
9+
10+
1. Definitions.
11+
12+
"License" shall mean the terms and conditions for use, reproduction,
13+
and distribution as defined by Sections 1 through 9 of this document.
14+
15+
"Licensor" shall mean the copyright owner or entity authorized by
16+
the copyright owner that is granting the License.
17+
18+
"Legal Entity" shall mean the union of the acting entity and all
19+
other entities that control, are controlled by, or are under common
20+
control with that entity. For the purposes of this definition,
21+
"control" means (i) the power, direct or indirect, to cause the
22+
direction or management of such entity, whether by contract or
23+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
24+
outstanding shares, or (iii) beneficial ownership of such entity.
25+
26+
"You" (or "Your") shall mean an individual or Legal Entity
27+
exercising permissions granted by this License.
28+
29+
"Source" form shall mean the preferred form for making modifications,
30+
including but not limited to software source code, documentation
31+
source, and configuration files.
32+
33+
"Object" form shall mean any form resulting from mechanical
34+
transformation or translation of a Source form, including but
35+
not limited to compiled object code, generated documentation,
36+
and conversions to other media types.
37+
38+
"Work" shall mean the work of authorship, whether in Source or
39+
Object form, made available under the License, as indicated by a
40+
copyright notice that is included in or attached to the work
41+
(an example is provided in the Appendix below).
42+
43+
"Derivative Works" shall mean any work, whether in Source or Object
44+
form, that is based on (or derived from) the Work and for which the
45+
editorial revisions, annotations, elaborations, or other modifications
46+
represent, as a whole, an original work of authorship. For the purposes
47+
of this License, Derivative Works shall not include works that remain
48+
separable from, or merely link (or bind by name) to the interfaces of,
49+
the Work and Derivative Works thereof.
50+
51+
"Contribution" shall mean any work of authorship, including
52+
the original version of the Work and any modifications or additions
53+
to that Work or Derivative Works thereof, that is intentionally
54+
submitted to Licensor for inclusion in the Work by the copyright owner
55+
or by an individual or Legal Entity authorized to submit on behalf of
56+
the copyright owner. For the purposes of this definition, "submitted"
57+
means any form of electronic, verbal, or written communication sent
58+
to the Licensor or its representatives, including but not limited to
59+
communication on electronic mailing lists, source code control systems,
60+
and issue tracking systems that are managed by, or on behalf of, the
61+
Licensor for the purpose of discussing and improving the Work, but
62+
excluding communication that is conspicuously marked or otherwise
63+
designated in writing by the copyright owner as "Not a Contribution."
64+
65+
"Contributor" shall mean Licensor and any individual or Legal Entity
66+
on behalf of whom a Contribution has been received by Licensor and
67+
subsequently incorporated within the Work.
68+
69+
2. Grant of Copyright License. Subject to the terms and conditions of
70+
this License, each Contributor hereby grants to You a perpetual,
71+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
72+
copyright license to reproduce, prepare Derivative Works of,
73+
publicly display, publicly perform, sublicense, and distribute the
74+
Work and such Derivative Works in Source or Object form.
75+
76+
3. Grant of Patent License. Subject to the terms and conditions of
77+
this License, each Contributor hereby grants to You a perpetual,
78+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
79+
(except as stated in this section) patent license to make, have made,
80+
use, offer to sell, sell, import, and otherwise transfer the Work,
81+
where such license applies only to those patent claims licensable
82+
by such Contributor that are necessarily infringed by their
83+
Contribution(s) alone or by combination of their Contribution(s)
84+
with the Work to which such Contribution(s) was submitted. If You
85+
institute patent litigation against any entity (including a
86+
cross-claim or counterclaim in a lawsuit) alleging that the Work
87+
or a Contribution incorporated within the Work constitutes direct
88+
or contributory patent infringement, then any patent licenses
89+
granted to You under this License for that Work shall terminate
90+
as of the date such litigation is filed.
91+
92+
4. Redistribution. You may reproduce and distribute copies of the
93+
Work or Derivative Works thereof in any medium, with or without
94+
modifications, and in Source or Object form, provided that You
95+
meet the following conditions:
96+
97+
(a) You must give any other recipients of the Work or
98+
Derivative Works a copy of this License; and
99+
100+
(b) You must cause any modified files to carry prominent notices
101+
stating that You changed the files; and
102+
103+
(c) You must retain, in the Source form of any Derivative Works
104+
that You distribute, all copyright, patent, trademark, and
105+
attribution notices from the Source form of the Work,
106+
excluding those notices that do not pertain to any part of
107+
the Derivative Works; and
108+
109+
(d) If the Work includes a "NOTICE" text file as part of its
110+
distribution, then any Derivative Works that You distribute must
111+
include a readable copy of the attribution notices contained
112+
within such NOTICE file, excluding those notices that do not
113+
pertain to any part of the Derivative Works, in at least one
114+
of the following places: within a NOTICE text file distributed
115+
as part of the Derivative Works; within the Source form or
116+
documentation, if provided along with the Derivative Works; or,
117+
within a display generated by the Derivative Works, if and
118+
wherever such third-party notices normally appear. The contents
119+
of the NOTICE file are for informational purposes only and
120+
do not modify the License. You may add Your own attribution
121+
notices within Derivative Works that You distribute, alongside
122+
or as an addendum to the NOTICE text from the Work, provided
123+
that such additional attribution notices cannot be construed
124+
as modifying the License.
125+
126+
You may add Your own copyright statement to Your modifications and
127+
may provide additional or different license terms and conditions
128+
for use, reproduction, or distribution of Your modifications, or
129+
for any such Derivative Works as a whole, provided Your use,
130+
reproduction, and distribution of the Work otherwise complies with
131+
the conditions stated in this License.
132+
133+
5. Submission of Contributions. Unless You explicitly state otherwise,
134+
any Contribution intentionally submitted for inclusion in the Work
135+
by You to the Licensor shall be under the terms and conditions of
136+
this License, without any additional terms or conditions.
137+
Notwithstanding the above, nothing herein shall supersede or modify
138+
the terms of any separate license agreement you may have executed
139+
with Licensor regarding such Contributions.
140+
141+
6. Trademarks. This License does not grant permission to use the trade
142+
names, trademarks, service marks, or product names of the Licensor,
143+
except as required for reasonable and customary use in describing the
144+
origin of the Work and reproducing the content of the NOTICE file.
145+
146+
7. Disclaimer of Warranty. Unless required by applicable law or
147+
agreed to in writing, Licensor provides the Work (and each
148+
Contributor provides its Contributions) on an "AS IS" BASIS,
149+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
150+
implied, including, without limitation, any warranties or conditions
151+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
152+
PARTICULAR PURPOSE. You are solely responsible for determining the
153+
appropriateness of using or redistributing the Work and assume any
154+
risks associated with Your exercise of permissions under this License.
155+
156+
8. Limitation of Liability. In no event and under no legal theory,
157+
whether in tort (including negligence), contract, or otherwise,
158+
unless required by applicable law (such as deliberate and grossly
159+
negligent acts) or agreed to in writing, shall any Contributor be
160+
liable to You for damages, including any direct, indirect, special,
161+
incidental, or consequential damages of any character arising as a
162+
result of this License or out of the use or inability to use the
163+
Work (including but not limited to damages for loss of goodwill,
164+
work stoppage, computer failure or malfunction, or any and all
165+
other commercial damages or losses), even if such Contributor
166+
has been advised of the possibility of such damages.
167+
168+
9. Accepting Warranty or Additional Liability. While redistributing
169+
the Work or Derivative Works thereof, You may choose to offer,
170+
and charge a fee for, acceptance of support, warranty, indemnity,
171+
or other liability obligations and/or rights consistent with this
172+
License. However, in accepting such obligations, You may act only
173+
on Your own behalf and on Your sole responsibility, not on behalf
174+
of any other Contributor, and only if You agree to indemnify,
175+
defend, and hold each Contributor harmless for any liability
176+
incurred by, or claims asserted against, such Contributor by reason
177+
of your accepting any such warranty or additional liability.
178+
179+
END OF TERMS AND CONDITIONS
180+
181+
DEPENDENCIES & ATTRIBUTION
182+
183+
The library links against the following external libraries or contains
184+
implementations from the following external libraries, which have their own
185+
licenses:
186+
187+
* Go <https://raw.githubusercontent.com/golang/go/master/LICENSE>
188+
189+
Copyright (c) 2009 The Go Authors. All rights reserved.
190+
191+
Redistribution and use in source and binary forms, with or without
192+
modification, are permitted provided that the following conditions are
193+
met:
194+
195+
* Redistributions of source code must retain the above copyright
196+
notice, this list of conditions and the following disclaimer.
197+
* Redistributions in binary form must reproduce the above
198+
copyright notice, this list of conditions and the following disclaimer
199+
in the documentation and/or other materials provided with the
200+
distribution.
201+
* Neither the name of Google Inc. nor the names of its
202+
contributors may be used to endorse or promote products derived from
203+
this software without specific prior written permission.
204+
205+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
206+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
207+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
208+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
209+
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
210+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
211+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
212+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
213+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
214+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
215+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎lib/node_modules/@stdlib/math/base/special/betainc/README.md‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,102 @@ for ( i = 0; i < 100; i++ ) {
122122

123123
<!-- /.examples -->
124124

125+
<!-- C interface documentation. -->
126+
127+
* * *
128+
129+
<section class="c">
130+
131+
## C APIs
132+
133+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
134+
135+
<section class="intro">
136+
137+
</section>
138+
139+
<!-- /.intro -->
140+
141+
<!-- C usage documentation. -->
142+
143+
<section class="usage">
144+
145+
### Usage
146+
147+
```c
148+
#include "stdlib/stats/base/dists/bernoulli/cdf.h"
149+
```
150+
151+
#### stdlib_base_betainc( x, a, b\[, regularized\[, upper]] )
152+
153+
Evaluates the incomplete beta function.
154+
155+
```c
156+
double y = stdlib_base_betainc( 0.5, 2.0, 2.0 );
157+
// returns ~0.5
158+
159+
y = stdlib_base_betainc( 0.5, 2.0, 2.0, false );
160+
// returns ~0.083
161+
162+
y = stdlib_base_betainc( 0.2, 1.0, 2.0 );
163+
// returns ~0.36
164+
```
165+
166+
The function accepts the following arguments:
167+
168+
- **x**: `[in] double` input value.
169+
- **a**: `[in] double`
170+
171+
```c
172+
double stdlib_base_betainc( const double x, const double alpha, const double beta );
173+
```
174+
175+
</section>
176+
177+
<!-- /.usage -->
178+
179+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
180+
181+
<section class="notes">
182+
183+
</section>
184+
185+
<!-- /.notes -->
186+
187+
<!-- C API usage examples. -->
188+
189+
<section class="examples">
190+
191+
### Examples
192+
193+
```c
194+
#include "stdlib/math/base/special/betainc.h"
195+
#include <stdlib.h>
196+
#include <stdio.h>
197+
198+
int main( void ) {
199+
double x;
200+
double a;
201+
double b;
202+
int i;
203+
204+
for ( i = 0; i < 100; i++ ) {
205+
x = ( (double)rand() / (double)RAND_MAX );
206+
a = ( (double)rand() / (double)RAND_MAX ) * 10.0;
207+
b = ( (double)rand() / (double)RAND_MAX ) * 10.0;
208+
printf( "x: %1f, \t a: %1f, \t b: %1f, \t f(x,a,b): %1f\n", x, a , b );
209+
}
210+
}
211+
```
212+
213+
</section>
214+
215+
<!-- /.examples -->
216+
217+
</section>
218+
219+
<!-- /.c -->
220+
125221
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
126222

127223
<section class="related">

‎lib/node_modules/@stdlib/math/base/special/betainc/benchmark/benchmark.native.js‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var resolve = require( 'path' ).resolve;
24+
var bench = require( '@stdlib/bench' );
25+
var randu = require( '@stdlib/random/base/randu' );
26+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
27+
var tryRequire = require( '@stdlib/utils/try-require' );
28+
var EPS = require( '@stdlib/constants/float64/eps' );
29+
var pkg = require( './../package.json' ).name;
30+
31+
32+
// VARIABLES //
33+
34+
var betainc = tryRequire( resolve( __dirname, './../lib/native.js' ) );
35+
var opts = {
36+
'skip': ( betainc instanceof Error )
37+
};
38+
39+
40+
// MAIN //
41+
42+
bench( pkg+'::native', opts, function benchmark( assert ) {
43+
var x;
44+
var y;
45+
var a;
46+
var b;
47+
var i;
48+
49+
assert.tic();
50+
for ( i = 0; i < assert.iterations; i++ ) {
51+
x = randu();
52+
a = ( randu()*1000.0 ) + EPS;
53+
b = ( randu()*1000.0 ) + EPS;
54+
y = betainc( x, a, b );
55+
if ( isnan( y ) ) {
56+
assert.fail( 'should not return NaN' );
57+
}
58+
}
59+
assert.toc();
60+
if ( isnan( y ) ) {
61+
assert.fail( 'should not return NaN' );
62+
}
63+
assert.pass( 'benchmark finished' );
64+
assert.end();
65+
});

0 commit comments

Comments
 (0)