time-to-botec

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

README.md (2317B)

      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 # isOrder
     22 
     23 > Test if an input value is an ndarray order.
     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 isOrder = require( '@stdlib/ndarray/base/assert/is-order' );
     41 ```
     42 
     43 #### isOrder( value )
     44 
     45 Tests if an input `value` is an ndarray order.
     46 
     47 ```javascript
     48 var bool = isOrder( 'row-major' );
     49 // returns true
     50 
     51 bool = isOrder( 'column-major' );
     52 // returns true
     53 ```
     54 
     55 </section>
     56 
     57 <!-- /.usage -->
     58 
     59 <!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
     60 
     61 <section class="notes">
     62 
     63 </section>
     64 
     65 <!-- /.notes -->
     66 
     67 <!-- Package usage examples. -->
     68 
     69 <section class="examples">
     70 
     71 ## Examples
     72 
     73 <!-- eslint no-undef: "error" -->
     74 
     75 ```javascript
     76 var isOrder = require( '@stdlib/ndarray/base/assert/is-order' );
     77 
     78 var bool = isOrder( 'row-major' );
     79 // returns true
     80 
     81 bool = isOrder( 'column-major' );
     82 // returns true
     83 
     84 bool = isOrder( '' );
     85 // returns false
     86 
     87 bool = isOrder( 'foo' );
     88 // returns false
     89 ```
     90 
     91 </section>
     92 
     93 <!-- /.examples -->
     94 
     95 <!-- 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. -->
     96 
     97 <section class="references">
     98 
     99 </section>
    100 
    101 <!-- /.references -->
    102 
    103 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
    104 
    105 <section class="links">
    106 
    107 </section>
    108 
    109 <!-- /.links -->