feat: add `math/base/special/chebyshev-t-polynomial` #5774

anandkaranubc · 2025-03-04T05:14:40Z

Progresses #123

Description

What is the purpose of this pull request?

This pull request:

Adds the JS implementation of the function to evaluate a Chebyshev polynomial of the first kind at a value x.

Related Issues

Does this pull request have any related issues?

This pull request:

progresses [RFC]: evaluate a Chebyshev polynomial of the first kind at a value x #123

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.

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: passed - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- 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: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - 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: na ---

anandkaranubc · 2025-03-04T05:15:33Z

/stdlib update-copyright-years

stdlib-bot · 2025-03-04T05:16:13Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/chebyshev-t-polynomial	$\color{green}137/137$ $\color{green}+100.00\%$	$\color{green}7/7$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}137/137$ $\color{green}+100.00\%$

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

anandkaranubc · 2025-03-04T05:16:32Z

Time to bring hyp2f1 to life! 🚀

Once this is approved, I will also add its respective C implementation. 😄

anandkaranubc · 2025-03-04T05:23:32Z

lib/node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/test/test.js

+			delta = abs( y - expected[ i ] );
+
+			// NOTE: The tolerance is higher due to the numerical differences between the `hyp2f1` implementation in JavaScript and its reference implementation in SciPy.
+			tol = 755.0 * EPS * abs( expected[ i ] );


I expected this from the start. Fortunately, they are not as crazy as hyp2f1. The test coverage report also confirms that this function only uses parts of the helper functions hyp2f1ra and hys2f1 that rely on evaluating the hypergeometric function through power series expansion. Thus, numerical differences…

lib/node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/README.md

anandkaranubc · 2025-03-04T05:33:47Z

...node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/test/fixtures/python/runner.py

+
+def main():
+    """Generate fixture data."""
+    x = np.linspace(-1, 1, 1000)


In the text fixture generation, I have kept x in the [-1,1] range, where these polynomials are typically considered. Is it also necessary to test outside of this interval?

For |x| > 1, the polynomials grow exponentially rather than oscillating. Our implementation can handle that since there is no restriction on x.

I'm fine leaving it in [-1,1] is that is the typical range.

anandkaranubc · 2025-03-04T05:34:31Z

lib/node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/lib/main.js

+	) {
+		return NaN;
+	}
+	return hyp2f1( -n, n, 0.5, 0.5*(1-x) );


No restrictions on x over here :)

Signed-off-by: Karan Anand <[email protected]>

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- 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: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: na - 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: na ---

Co-authored-by: Karan Anand <[email protected]> Signed-off-by: Athan <[email protected]>

kgryte · 2025-04-02T23:22:49Z

lib/node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/README.md

+
+# chebyshevtpoly
+
+> [Chebyshev Polynomial][chebyshev-polynomial] of the first kind.


Suggested change

> [Chebyshev Polynomial][chebyshev-polynomial] of the first kind.

> [Chebyshev polynomial][chebyshev-polynomial] of the first kind.

"polynomial" does not need to be capitalized. Applies here and elsewhere throughout this package.

kgryte · 2025-04-02T23:24:18Z

lib/node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/README.md

+
+where `n` is the polynomial degree.
+
+The [Chebyshev Polynomial][chebyshev-polynomial] of the first kind is related to the Gaussian hypergeometric function via the following equation


Suggested change

The [Chebyshev Polynomial][chebyshev-polynomial] of the first kind is related to the Gaussian hypergeometric function via the following equation

The [Chebyshev Polynomial][chebyshev-polynomial] of the first kind is related to the [Gaussian hypergeometric function][@stdlib/math/base/special/hyp2f1] via the following equation

You'll need to add the link defn below in the links section. Also double-check that I used the correct package name.

kgryte · 2025-04-02T23:25:52Z

lib/node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/README.md

+// returns NaN
+```
+
+If provided a polynomial degree `n` which is not a nonnegative integer, the function returns `NaN`.


Why do we restrict to only integer degrees? Why not follow SciPy and state that non-integer values are resolved relative to the hypergeometric function?

kgryte · 2025-04-02T23:26:21Z

lib/node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/README.md

+<!-- eslint no-undef: "error" -->
+
+```javascript
+var randu = require( '@stdlib/random/base/randu' );


We can update this example to use console/log-each-map.

kgryte · 2025-04-02T23:26:38Z

lib/node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/README.md

+
+<section class="links">
+
+[chebyshev-polynomial]: https://en.wikipedia.org/wiki/Chebyshev_polynomials#Definitions


You can drop #Definitions here.

kgryte · 2025-04-02T23:27:14Z

lib/node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/docs/repl.txt

@@ -0,0 +1,38 @@
+
+{{alias}}( n, x )
+    Evaluates the Chebyshev polynomial of the first kind


Your line wrapping is off here.

kgryte · 2025-04-02T23:27:45Z

lib/node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/examples/index.js

+'use strict';
+
+var randu = require( '@stdlib/random/base/randu' );
+var round = require( '@stdlib/math/base/special/round' );


Same comment as README.

kgryte · 2025-04-02T23:28:17Z

lib/node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/lib/main.js

+function chebyshevtpoly( n, x ) {
+	if (
+		isnan( x ) ||
+		!isInteger( n ) ||


Not clear to me that we need to apply this restriction.

kgryte · 2025-04-02T23:30:06Z

lib/node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/lib/main.js

+	) {
+		return NaN;
+	}
+	return hyp2f1( -n, n, 0.5, 0.5*(1.0-x) );


For integer x, why not use the recurrence relation directly, as in SciPy?

kgryte · 2025-04-02T23:30:39Z

lib/node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/package.json

+{
+  "name": "@stdlib/math/base/special/chebyshev-t-polynomial",
+  "version": "0.0.0",
+  "description": "Evaluates the Chebyshev polynomial of the first kind.",


Suggested change

"description": "Evaluates the Chebyshev polynomial of the first kind.",

"description": "Evaluate the Chebyshev polynomial of the first kind.",

kgryte

Left an initial round of comments.

anandkaranubc added 5 commits February 19, 2025 01:35

feat: temp commit

c27f143

stdlib-bot added Math Issue or pull request specific to math functionality. Needs Review A pull request which needs code review. labels Mar 4, 2025

stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Mar 4, 2025

chore: update copyright years

a059fc7

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Mar 4, 2025

anandkaranubc commented Mar 4, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/README.md Show resolved Hide resolved

anandkaranubc commented Mar 4, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/chebyshev-t-polynomial/README.md Outdated Show resolved Hide resolved

anandkaranubc commented Mar 4, 2025

View reviewed changes

anandkaranubc and others added 3 commits March 3, 2025 21:38

Merge branch 'stdlib-js:develop' into feat/chebyshevtpoly

6dfe7ff

chore: change 1 to 1.0

dec6ced

Signed-off-by: Karan Anand <[email protected]>

anandkaranubc added the JavaScript Issue involves or relates to JavaScript. label Mar 4, 2025

anandkaranubc and others added 2 commits April 1, 2025 22:58

Merge branch 'stdlib-js:develop' into feat/chebyshevtpoly

dce324e

docs: update copy

8d69084

Co-authored-by: Karan Anand <[email protected]> Signed-off-by: Athan <[email protected]>

kgryte reviewed Apr 2, 2025

View reviewed changes

kgryte requested changes Apr 2, 2025

View reviewed changes

kgryte added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Apr 2, 2025

anandkaranubc marked this pull request as draft April 11, 2025 07:31


		# chebyshevtpoly

		> [Chebyshev Polynomial][chebyshev-polynomial] of the first kind.


		where `n` is the polynomial degree.

		The [Chebyshev Polynomial][chebyshev-polynomial] of the first kind is related to the Gaussian hypergeometric function via the following equation


		<section class="links">

		[chebyshev-polynomial]: https://en.wikipedia.org/wiki/Chebyshev_polynomials#Definitions

		@@ -0,0 +1,38 @@

		{{alias}}( n, x )
		Evaluates the Chebyshev polynomial of the first kind

	"description": "Evaluates the Chebyshev polynomial of the first kind.",
	"description": "Evaluate the Chebyshev polynomial of the first kind.",

Uh oh!

feat: add math/base/special/chebyshev-t-polynomial #5774

Are you sure you want to change the base?

feat: add math/base/special/chebyshev-t-polynomial #5774

Uh oh!

Conversation

anandkaranubc commented Mar 4, 2025 • edited by kgryte Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Questions

Other

Checklist

Uh oh!

anandkaranubc commented Mar 4, 2025

Uh oh!

stdlib-bot commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

anandkaranubc commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kgryte left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: add `math/base/special/chebyshev-t-polynomial` #5774

feat: add `math/base/special/chebyshev-t-polynomial` #5774

anandkaranubc commented Mar 4, 2025 •

edited by kgryte

Loading

stdlib-bot commented Mar 4, 2025 •

edited

Loading

anandkaranubc commented Mar 4, 2025 •

edited

Loading