time-to-botec

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

README.md (2406B)

      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 # Wrap Index
     22 
     23 > Wrap an index on the interval `[0,max]`.
     24 
     25 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
     26 
     27 <section class="intro">
     28 
     29 </section>
     30 
     31 <!-- /.intro -->
     32 
     33 <!-- Package usage documentation. -->
     34 
     35 <section class="usage">
     36 
     37 ## Usage
     38 
     39 ```javascript
     40 var wrapIndex = require( '@stdlib/ndarray/base/wrap-index' );
     41 ```
     42 
     43 #### wrapIndex( idx, max )
     44 
     45 Wrap an index on the interval `[0,max]`.
     46 
     47 ```javascript
     48 var idx = wrapIndex( 2, 10 );
     49 // returns 2
     50 
     51 idx = wrapIndex( -5, 10 );
     52 // returns 6
     53 
     54 idx = wrapIndex( 15, 10 );
     55 // returns 4
     56 ```
     57 
     58 </section>
     59 
     60 <!-- /.usage -->
     61 
     62 <!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
     63 
     64 <section class="notes">
     65 
     66 </section>
     67 
     68 <!-- /.notes -->
     69 
     70 <!-- Package usage examples. -->
     71 
     72 <section class="examples">
     73 
     74 ## Examples
     75 
     76 <!-- eslint no-undef: "error" -->
     77 
     78 ```javascript
     79 var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
     80 var wrapIndex = require( '@stdlib/ndarray/base/wrap-index' );
     81 
     82 var idx;
     83 var out;
     84 var i;
     85 
     86 for ( i = 0; i < 100; i++ ) {
     87     idx = discreteUniform( -20, 20 );
     88     out = wrapIndex( idx, 9 );
     89     console.log( '%d => [%d,%d] => %d', idx, 0, 9, out );
     90 }
     91 ```
     92 
     93 </section>
     94 
     95 <!-- /.examples -->
     96 
     97 <!-- 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. -->
     98 
     99 <section class="references">
    100 
    101 </section>
    102 
    103 <!-- /.references -->
    104 
    105 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
    106 
    107 <section class="links">
    108 
    109 </section>
    110 
    111 <!-- /.links -->