@stdlib/math-iter-utils-continued-fraction
TypeScript icon, indicating that this package has built-in type declarations

0.2.2 • Public • Published
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

iterContinuedFraction

NPM version Build Status Coverage Status

Evaluate the terms of a continued fraction.

A generalized continued fraction has the form

Continued fraction
-->

If a_i = 1 for all i, the above expression reduces to a simple continued fraction.

where the values b_i are called the coefficients or terms of the continued fraction.

Installation

npm install @stdlib/math-iter-utils-continued-fraction

Usage

var iterContinuedFraction = require( '@stdlib/math-iter-utils-continued-fraction' );

iterContinuedFraction( iterator[, options] )

Evaluates the terms of a continued fraction.

var array2iterator = require( '@stdlib/array-to-iterator' );

var arr = array2iterator( [ 3, 4, 12, 4 ] );

var v = iterContinuedFraction( arr );
// returns ~3.245

The function supports the following options:

  • iter: maximum number of iterations. Default: 1e308.
  • tol: tolerance at which to terminate further evaluation of the continued fraction. Default: floating-point epsilon.

To explicitly cap the maximum number of iterations, set the iter option.

var array2iterator = require( '@stdlib/array-to-iterator' );

var arr = array2iterator( [ 3, 4, 12, 4 ] );

var opts = {
    'iter': 2
};
var v = iterContinuedFraction( arr, opts );
// returns 3.25

The function terminates continued fraction evaluation once the difference between continued fraction approximations is sufficiently small. The default tolerance is floating-point epsilon (~2.22e-16). Once an update to a continued fraction approximation is less than or equal to this tolerance, the function terminates evaluation. To adjust the tolerance (e.g., to return a rough approximation), set the tol option.

var iterContinuedFractionSeq = require( '@stdlib/math-iter-sequences-continued-fraction' );

var opts = {
    'tol': 1.0e-7
};
var it = iterContinuedFractionSeq( 3.141592653589793, opts );
// returns <Object>

var v = iterContinuedFraction( it );
// returns ~3.14159292

Notes

  • If an iterated value is non-numeric (including NaN), the function returns NaN. If non-numeric iterated values are possible, you are advised to provide an iterator which type checks and handles non-numeric values accordingly.

Examples

var iterContinuedFractionSeq = require( '@stdlib/math-iter-sequences-continued-fraction' );
var PI = require( '@stdlib/constants-float64-pi' );
var iterContinuedFraction = require( '@stdlib/math-iter-utils-continued-fraction' );

// Create an iterator for returning the list of continued fraction terms:
var it = iterContinuedFractionSeq( PI );

// Reconstitute the original value:
var v = iterContinuedFraction( it );
// returns <number>

console.log( 'Value: %d.', v );

See Also


Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/math-iter-utils-continued-fraction

Homepage

stdlib.io

Weekly Downloads

34

Version

0.2.2

License

Apache-2.0

Unpacked Size

59.4 kB

Total Files

14

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser