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 stats/base/dists/levy/median #4076

Open
wants to merge 13 commits into
base: develop
Choose a base branch
from

Conversation

vivekmaurya001
Copy link
Contributor

Resolves #3727.

Description

  • adds C implementation for @stdlib/stats/base/dists/levy/median along with relevant tests, benchmarks and examples

This pull request:

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.


@stdlib-js/reviewers

@stdlib-bot stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. labels Dec 20, 2024
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Dec 20, 2024

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/levy/median $\color{green}182/182$
$\color{green}+100.00\%$
$\color{green}9/9$
$\color{green}+100.00\%$
$\color{green}2/2$
$\color{green}+100.00\%$
$\color{green}182/182$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

@Planeshifter
Copy link
Member

/stdlib update-copyright-years

@stdlib-bot stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Jan 19, 2025
@stdlib-bot stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Jan 19, 2025
* // returns ~0.795
*/
double stdlib_base_dists_levy_median( const double mu, const double c ) {
double DENOM = 2.0 * stdlib_base_pow( stdlib_base_erfcinv( 0.5 ), 2.0 );
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vivekmaurya001 We should pre-compute this constant as a static const in the outer scope since erfcinv(0.5) is constant and doesn't change with the inputs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ook

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i have tried it with static const but i was getting error in that so i have maded it static double , is it ok ?

Comment on lines 22 to 25
#include "stdlib/math/base/special/pow.h"


/**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#include "stdlib/math/base/special/pow.h"
/**
#include "stdlib/math/base/special/pow.h"
/**


#### stdlib_base_dists_levy_median( mu, c )

Evaluates the [median][median] for a [Lévy][levy-distribution] distribution with location parameter `mu` and scale parameter `c`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Evaluates the [median][median] for a [Lévy][levy-distribution] distribution with location parameter `mu` and scale parameter `c`.
Returns the [median][median] for a [Lévy][levy-distribution] distribution with location parameter `mu` and scale parameter `c`.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

int i;

for ( i = 0; i < 25; i++ ) {
mu = random_uniform( 0.0, 10.0 ) - 5.0;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
mu = random_uniform( 0.0, 10.0 ) - 5.0;
mu = random_uniform( -5.0, 5.0 );

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

int i;

for ( i = 0; i < 25; i++ ) {
mu = random_uniform( 0.0, 10.0 ) - 5.0;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
mu = random_uniform( 0.0, 10.0 ) - 5.0;
mu = random_uniform( -5.0, 5.0 );

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Comment on lines 104 to 105
mu[ i ] = random_uniform( 0.0, 100.0 ) - 50.0;
c[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
mu[ i ] = random_uniform( 0.0, 100.0 ) - 50.0;
c[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
mu[ i ] = random_uniform( -50.0, 50.0 );
c[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done , one thing to ask ,can we not take c as 0 or smaller than eps

Copy link
Member

@Planeshifter Planeshifter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a comment on how to optimize the source implementation and pointed out a bunch of other small issues. Should be ready to land once these are addressed.

@Planeshifter Planeshifter added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Jan 19, 2025
@vivekmaurya001 vivekmaurya001 marked this pull request as draft January 20, 2025 19:18
---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
  - task: run_javascript_examples
    status: na
  - task: run_c_examples
    status: failed
---
---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
  - task: run_javascript_examples
    status: na
  - task: run_c_examples
    status: failed
---
---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
  - task: run_javascript_examples
    status: na
  - task: run_c_examples
    status: failed
---
---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
  - task: run_javascript_examples
    status: na
  - task: run_c_examples
    status: failed
---
---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
  - task: run_javascript_examples
    status: na
  - task: run_c_examples
    status: passed
  - task: run_cpp_examples
    status: na
  - task: run_javascript_readme_examples
    status: passed
  - task: run_c_benchmarks
    status: passed
  - task: run_cpp_benchmarks
    status: na
  - task: run_fortran_benchmarks
    status: na
  - task: run_javascript_benchmarks
    status: na
  - task: run_julia_benchmarks
    status: na
  - task: run_python_benchmarks
    status: na
  - task: run_r_benchmarks
    status: na
  - task: run_javascript_tests
    status: passed
---
@vivekmaurya001 vivekmaurya001 marked this pull request as ready for review January 21, 2025 12:39
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jan 21, 2025
@vivekmaurya001
Copy link
Contributor Author

@Planeshifter , done the changes please take a look

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Changes Pull request which needs changes before being merged. Needs Review A pull request which needs code review. Statistics Issue or pull request related to statistical functionality.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[RFC]: Add C implementation for @stdlib/stats/base/dists/levy/median
3 participants