feat: docs added

Author: aayush0325

lib/node_modules/@stdlib/math/base/special/cfloorf/docs/repl.txt

@@ -0,0 +1,27 @@
+
+{{alias}}( z )
+    Rounds a single-precision complex floating-point number toward negative
+    infinity.
+
+    Parameters
+    ----------
+    z: Complex64
+        Complex number.
+
+    Returns
+    -------
+    out: Complex64
+        Result.
+
+    Examples
+    --------
+    > var v = {{alias}}( new {{alias:@stdlib/complex/float32/ctor}}( 5.5, 3.3 ) )
+    <Complex64>
+    > var re = {{alias:@stdlib/complex/float32/real}}( v )
+    5.0
+    > var im = {{alias:@stdlib/complex/float32/imag}}( v )
+    3.0
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/math/base/special/cfloorf/docs/types/index.d.ts

@@ -0,0 +1,50 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 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.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { Complex64 } from '@stdlib/types/complex';
+
+/**
+* Rounds a single-precision complex floating-point number toward negative infinity.
+*
+* @param z - input value
+* @returns result
+*
+* @example
+* var Complex64 = require( '@stdlib/complex/float32/ctor' );
+* var real = require( '@stdlib/complex/float32/real' );
+* var imag = require( '@stdlib/complex/float32/imag' );
+*
+* var v = cfloorf( new Complex64( 5.5, 3.3 ) );
+* // returns <Complex64>
+*
+* var re = real( v );
+* // returns 5.0
+*
+* var im = imag( v );
+* // returns 3.0
+*/
+declare function cfloorf( z: Complex64 ): Complex64;
+
+
+// EXPORTS //
+
+export = cfloorf;

lib/node_modules/@stdlib/math/base/special/cfloorf/docs/types/test.ts

@@ -0,0 +1,46 @@
+/*
+* @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.
+*/
+
+import Complex64 = require( '@stdlib/complex/float32/ctor' );
+import cfloorf = require( './index' );
+
+
+// TESTS //
+
+// The function returns an array of numbers...
+{
+	cfloorf( new Complex64( 1.0, 2.0 ) ); // $ExpectType Complex64
+}
+
+// The compiler throws an error if the function is provided a value other than a complex number...
+{
+	cfloorf( 2 ); // $ExpectError
+	cfloorf( true ); // $ExpectError
+	cfloorf( false ); // $ExpectError
+	cfloorf( null ); // $ExpectError
+	cfloorf( undefined ); // $ExpectError
+	cfloorf( '5' ); // $ExpectError
+	cfloorf( [] ); // $ExpectError
+	cfloorf( {} ); // $ExpectError
+	cfloorf( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided insufficient arguments...
+{
+	cfloorf(); // $ExpectError
+}