Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add C implementation for @stdlib/stats/base/dists/studentized-range/cdf #4154

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 4 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
62 changes: 31 additions & 31 deletions lib/node_modules/@stdlib/ndarray/map/docs/types/index.d.ts

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,93 @@ out = tukey.quantile( 0.9, r, v, n );

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<!-- 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/stats/base/dists/studentized-range"
```

### tukey

[Studentized range][studentized-range] distribution.

```c
studentized_range_t dist;
```

The namespace contains the following distribution functions:

- `cdf( x, r, v[, nranges=1] )`: Studentized range distribution cumulative distribution function (CDF).
- `quantile( p, r, v[, nranges=1] )`: Studentized range distribution quantile function.

</section>

<section class="examples">

### Examples: Using the CDF Function

```c
#include <stdio.h>
#include "studentized_range.h"

int main() {
// Parameters for the Studentized Range distribution:
double r = 5.0; // Number of means
double v = 20.0; // Degrees of freedom
double n = 3.0; // Number of ranges
double x = 2.0; // Value at which to calculate the CDF

// Calculate the cumulative distribution function (CDF):
double cdf = studentized_range_cdf( x, r, v, n );
printf( "CDF at x = %.2f: %.4f\n", x, cdf );

return 0;
}
```

### Examples: Using the Quantile Function

```c
#include <stdio.h>
#include "studentized_range.h"

int main() {
// Parameters for the Studentized Range distribution:
double r = 5.0; // Number of means
double v = 20.0; // Degrees of freedom
double n = 3.0; // Number of ranges
double p = 0.9; // Probability value

// Calculate the quantile function:
double quantile = studentized_range_quantile( p, r, v, n );
printf( "Quantile at p = %.2f: %.4f\n", p, quantile );

return 0;
}
```

</section>

<section class="related">

</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,71 @@ for ( i = 0; i < 10; i++ ) {

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<!-- 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/stats/base/dists/studentized-range"
```

### tukey

[Studentized range][studentized-range] distribution.

```c
studentized_range_t dist;
```

The namespace contains the following distribution functions:

- `cdf( x, r, v[, nranges=1] )`: Studentized range distribution cumulative distribution function (CDF).

</section>

<section class="examples">

### Examples: Using the CDF Function

```c
#include <stdio.h>
#include "studentized_range.h"

int main() {
// Parameters for the Studentized Range distribution:
double r = 5.0; // Number of means
double v = 20.0; // Degrees of freedom
double n = 3.0; // Number of ranges
double x = 2.0; // Value at which to calculate the CDF

// Calculate the cumulative distribution function (CDF):
double cdf = studentized_range_cdf( x, r, v, n );
printf( "CDF at x = %.2f: %.4f\n", x, cdf );

return 0;
}
```

</section>

<section class="related">

</section>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
#/
# @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.
#/

# VARIABLES #

ifndef VERBOSE
QUIET := @
else
QUIET :=
endif

# Determine the OS ([1][1], [2][2]).
#
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
# [2]: http://stackoverflow.com/a/27776822/2225624
OS ?= $(shell uname)
ifneq (, $(findstring MINGW,$(OS)))
OS := WINNT
else
ifneq (, $(findstring MSYS,$(OS)))
OS := WINNT
else
ifneq (, $(findstring CYGWIN,$(OS)))
OS := WINNT
else
ifneq (, $(findstring Windows_NT,$(OS)))
OS := WINNT
endif
endif
endif
endif

# Define the program used for compiling C source files:
ifdef C_COMPILER
CC := $(C_COMPILER)
else
CC := gcc
endif

# Define the command-line options when compiling C files:
CFLAGS ?= \
-std=c99 \
-O3 \
-Wall \
-pedantic

# Determine whether to generate position independent code ([1][1], [2][2]).
#
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
ifeq ($(OS), WINNT)
fPIC ?=
else
fPIC ?= -fPIC
endif

# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`):
INCLUDE ?=

# List of source files:
SOURCE_FILES ?=

# List of libraries (e.g., `-lopenblas -lpthread`):
LIBRARIES ?=

# List of library paths (e.g., `-L /foo/bar -L /beep/boop`):
LIBPATH ?=

# List of C targets:
c_targets := benchmark.out


# RULES #

#/
# Compiles source files.
#
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
# @param {string} [CFLAGS] - C compiler options
# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`)
# @param {string} [SOURCE_FILES] - list of source files
# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`)
#
# @example
# make
#
# @example
# make all
#/
all: $(c_targets)

.PHONY: all

#/
# Compiles C source files.
#
# @private
# @param {string} CC - C compiler (e.g., `gcc`)
# @param {string} CFLAGS - C compiler options
# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`)
# @param {string} SOURCE_FILES - list of source files
# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`)
# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`)
#/
$(c_targets): %.out: %.c
$(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES)

#/
# Runs compiled benchmarks.
#
# @example
# make run
#/
run: $(c_targets)
$(QUIET) ./$<

.PHONY: run

#/
# Removes generated files.
#
# @example
# make clean
#/
clean:
$(QUIET) -rm -f *.o *.out

.PHONY: clean
Loading
Loading