docs: docs added

Author: aayush0325

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

@@ -35,7 +35,7 @@ f(n) = \left \lfloor{ n + 1 + \log_\varphi \biggl( \sqrt{5}( n + 1 + \log_\varph
 ```
 
 <!-- <div class="equation" align="center" data-raw-text="f(n) = \left \lfloor{ n + 1 + \log_\varphi \biggl( \sqrt{5}( n + 1 + \log_\varphi(\sqrt{5}(n+1))) - 5 + \tfrac{3}{n+1} \biggr) - 2 } \right \rfloor" data-equation="eq:nonfibonaccif_number">
-    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@bb29798906e119fcb2af99e94b60407a270c9b32/lib/node_modules/@stdlib/math/base/special/nonfibonaccif/docs/img/equation_nonfibonaccif_number.svg" alt="Formula to compute the nth non-Fibonacci number.">
+    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@bb29798906e119fcb2af99e94b60407a270c9b32/lib/node_modules/@stdlib/math/base/special/nonfibonaccif/docs/img/equation_nonfibonacci_number.svg" alt="Formula to compute the nth non-Fibonacci number.">
     <br>
 </div> -->
 

lib/node_modules/@stdlib/math/base/special/nonfibonaccif/docs/img/equation_nonfibonacci_number.svg

@@ -0,0 +1,33 @@
+
+{{alias}}( n )
+    Computes the nth non-Fibonacci number in
+    single-precision floating-point format.
+
+    If not provided a nonnegative integer value, the function returns `NaN`.
+
+    If provided `NaN`, the function returns `NaN`.
+
+    Parameters
+    ----------
+    n: integer
+        Input value.
+
+    Returns
+    -------
+    y: number
+        Non-Fibonacci number.
+
+    Examples
+    --------
+    > var v = {{alias}}( 1 )
+    4
+    > v = {{alias}}( 2 )
+    6
+    > v = {{alias}}( 3 )
+    7
+    > v = {{alias}}( NaN )
+    NaN
+
+    See Also
+    --------
+

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

@@ -0,0 +1,60 @@
+/*
+* @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
+
+/**
+* Computes the nth non-Fibonacci number in single-precision floating-point format.
+*
+* ## Notes
+*
+* -   If not provided a nonnegative integer value, the function returns `NaN`.
+*
+* @param n - the non-Fibonacci number to compute
+* @returns non-Fibonacci number
+*
+* @example
+* var v = nonfibonaccif( 1 );
+* // returns 4
+*
+* @example
+* var v = nonfibonaccif( 2 );
+* // returns 6
+*
+* @example
+* var v = nonfibonaccif( 3 );
+* // returns 7
+*
+* @example
+* var v = nonfibonaccif( NaN );
+* // returns NaN
+*
+* @example
+* var v = nonfibonaccif( 3.14 );
+* // returns NaN
+*
+* @example
+* var v = nonfibonaccif( -1 );
+* // returns NaN
+*/
+declare function nonfibonaccif( n: number ): number;
+
+
+// EXPORTS //
+
+export = nonfibonaccif;

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

@@ -0,0 +1,44 @@
+/*
+* @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.
+*/
+
+import nonfibonaccif = require( './index' );
+
+
+// TESTS //
+
+// The function returns a number...
+{
+	nonfibonaccif( 8 ); // $ExpectType number
+}
+
+// The compiler throws an error if the function is provided a value other than a number...
+{
+	nonfibonaccif( true ); // $ExpectError
+	nonfibonaccif( false ); // $ExpectError
+	nonfibonaccif( null ); // $ExpectError
+	nonfibonaccif( undefined ); // $ExpectError
+	nonfibonaccif( '5' ); // $ExpectError
+	nonfibonaccif( [] ); // $ExpectError
+	nonfibonaccif( {} ); // $ExpectError
+	nonfibonaccif( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided insufficient arguments...
+{
+	nonfibonaccif(); // $ExpectError
+}