time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

README.md (1810B)

      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2018 The Stdlib Authors.
      6 
      7 Licensed under the Apache License, Version 2.0 (the "License");
      8 you may not use this file except in compliance with the License.
      9 You may obtain a copy of the License at
     10 
     11    http://www.apache.org/licenses/LICENSE-2.0
     12 
     13 Unless required by applicable law or agreed to in writing, software
     14 distributed under the License is distributed on an "AS IS" BASIS,
     15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     16 See the License for the specific language governing permissions and
     17 limitations under the License.
     18 
     19 -->
     20 
     21 # Logspace
     22 
     23 > Generate a logarithmically spaced numeric array.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var logspace = require( '@stdlib/array/logspace' );
     31 ```
     32 
     33 #### logspace( a, b\[, length] )
     34 
     35 Generates a logarithmically spaced numeric `array` between `10^a` and `10^b`. If a `length` is not provided, the default output `array` length is `10`.
     36 
     37 ```javascript
     38 var arr = logspace( 0, 2, 6 );
     39 // returns [ 1, ~2.5, ~6.31, ~15.85, ~39.81, 100 ]
     40 ```
     41 
     42 </section>
     43 
     44 <!-- /.usage -->
     45 
     46 <section class="notes">
     47 
     48 ## Notes
     49 
     50 -   The output `array` includes the values `10^a` and `10^b`. **Beware** of floating point errors, including for the first and last `array` elements.
     51 
     52 </section>
     53 
     54 <!-- /.notes -->
     55 
     56 <section class="examples">
     57 
     58 ## Examples
     59 
     60 <!-- eslint no-undef: "error" -->
     61 
     62 ```javascript
     63 var logspace = require( '@stdlib/array/logspace' );
     64 var out;
     65 
     66 // Default behavior:
     67 out = logspace( 0, 3 );
     68 console.log( out.join( '\n' ) );
     69 
     70 // Specify length:
     71 out = logspace( 0, 3, 100 );
     72 console.log( out.join( '\n' ) );
     73 
     74 // Create an array with decremented values:
     75 out = logspace( 3, 0, 10 );
     76 console.log( out.join( '\n' ) );
     77 ```
     78 
     79 </section>
     80 
     81 <!-- /.examples -->
     82 
     83 <section class="links">
     84 
     85 </section>
     86 
     87 <!-- /.links -->