feat: add math/base/special/lcmf

lib/node_modules/@stdlib/math/base/special/lcmf/README.md

@@ -0,0 +1,227 @@
+<!--
+
+@license Apache-2.0
+
+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.
+
+-->
+
+# lcmf
+
+> Compute the [least common multiple][lcm] of all integers from 1 up to a specified integer \( n \).
+
+<!-- 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">
+
+The [least common multiple][lcm] of a set of integers is the smallest positive integer that is divisible by each number in the set. This function computes the LCM[lcm] for all integers from 1 up to a given integer \( n \), which is especially useful in various mathematical and computational applications.
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var lcmf = require( '@stdlib/math/base/special/lcmf' );
+```
+
+### lcmf(n)
+Computes the [least common multiple][lcm] for all integers from 1 up to n.
+
+```javascript
+var v = lcmf( 10 );
+// returns 2520
+```
+
+If n is less than 1, the function returns 0.
+
+```javascript
+var v = lcmf( 0 );
+// returns 0
+
+v = lcmf( -5 );
+// returns 0
+```
+
+The input n must be an integer; otherwise, the function returns NaN.
+
+```javascript
+var v = lcmf( 3.14 );
+// returns NaN
+
+v = lcmf( NaN );
+// returns NaN
+```
+
+</section> 
+
+<!-- /.usage --> 
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> 
+
+<section class="notes"> 
+
+</section> 
+
+<!-- /.notes --> 
+
+<!-- Package usage examples. --> 
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var lcmf = require( '@stdlib/math/base/special/lcmf' );
+
+var v;
+var i;
+
+for ( i = 1; i <= 10; i++ ) {
+    v = lcmf( i );
+    console.log( 'lcm(1 to %d) = %d', i, v );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- 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/math/base/special/lcmf.h"
+```
+
+### stdlib_base_lcmf( n )
+
+Computes the [least common multiple][lcm] for all integers from 1 up to n.
+
+```c
+double v = stdlib_base_lcmf( 10 );
+// returns 2520.0
+```
+
+The function accepts the following argument:
+
+-   **n**: `[in] double` input value.
+
+```c
+double stdlib_base_lcmf( const double n );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/math/base/special/lcmf.h"
+#include <stdio.h>
+
+int main( void ) {
+    double v;
+    int i;
+    for ( i = 1; i <= 10; i++ ) {
+        v = stdlib_base_lcmf( i );
+        printf( "lcm(1 to %d) = %lf\n", i, v );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/math/base/special/gcd`][@stdlib/math/base/special/gcd]</span><span class="delimiter">: </span><span class="description">compute the greatest common divisor (gcd).</span>
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[lcm]: https://en.wikipedia.org/wiki/Least_common_multiple
+
+<!-- <related-links> -->
+
+[@stdlib/math/base/special/gcd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/gcd
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->
+

lib/node_modules/@stdlib/math/base/special/lcmf/benchmark/benchmark.js

@@ -0,0 +1,53 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var randu = require( '@stdlib/random/base/randu' );
+var round = require( '@stdlib/math/base/special/round' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pkg = require( './../package.json' ).name;
+var lcmf = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var x;
+	var y;
+	var z;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		x = round( randu() * 50.0 );
+		z = lcmf( x );
+		if ( isnan( z ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( z ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

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

@@ -0,0 +1,60 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var resolve = require( 'path' ).resolve;
+var bench = require( '@stdlib/bench' );
+var randu = require( '@stdlib/random/base/randu' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var tryRequire = require( '@stdlib/utils/try-require' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var lcmf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var opts = {
+    'skip': ( lcmf instanceof Error )
+};
+
+
+// MAIN //
+
+bench( pkg+'::native', opts,function benchmark( b ) {
+    var x;
+    var y;
+    var i;
+
+    b.tic();
+    for( i = 0;i < b.iterations; i++ ) {
+        x = ( randu() * 100.0 ) + 1.0;
+        y = lcmf( x );
+        if( isnan( y ) ) {
+            b.fail( 'should not return NaN' );
+        }
+    }
+    b.toc();
+    if( isnan( y ) ) {
+        b.fail( 'should not return NaN' );
+    }
+    b.pass( 'benchmark finished' );
+    b.end();
+});