time-to-botec

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

README.md (2171B)

      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 # isSkewCentrosymmetricMatrix
     22 
     23 > Test if a value is a [skew-centrosymmetric matrix][centrosymmetric-matrix].
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 <!-- eslint-disable id-length -->
     30 
     31 ```javascript
     32 var isSkewCentrosymmetricMatrix = require( '@stdlib/assert/is-skew-centrosymmetric-matrix' );
     33 ```
     34 
     35 #### isSkewCentrosymmetricMatrix( value )
     36 
     37 Tests if a value is a [skew-centrosymmetric matrix][centrosymmetric-matrix].
     38 
     39 <!-- eslint-disable id-length -->
     40 
     41 <!-- eslint-disable array-element-newline -->
     42 
     43 ```javascript
     44 var ndarray = require( '@stdlib/ndarray/ctor' );
     45 
     46 var buffer = [
     47     1, 2, 3,
     48     4, 0, -4,
     49     -3, -2, -1
     50 ];
     51 var arr = ndarray( 'generic', buffer, [ 3, 3 ], [ 3, 1 ], 0, 'row-major' );
     52 
     53 var bool = isSkewCentrosymmetricMatrix( arr );
     54 // returns true
     55 ```
     56 
     57 </section>
     58 
     59 <!-- /.usage -->
     60 
     61 <section class="examples">
     62 
     63 ## Examples
     64 
     65 <!-- eslint no-undef: "error" -->
     66 
     67 <!-- eslint-disable id-length -->
     68 
     69 ```javascript
     70 var ndarray = require( '@stdlib/ndarray/ctor' );
     71 var isSkewCentrosymmetricMatrix = require( '@stdlib/assert/is-skew-centrosymmetric-matrix' );
     72 
     73 var arr = ndarray( 'generic', [ 2, 1, -1, -2 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
     74 var out = isSkewCentrosymmetricMatrix( arr );
     75 // returns true
     76 
     77 out = isSkewCentrosymmetricMatrix( [ 1, 2, 3, 4 ] );
     78 // returns false
     79 
     80 out = isSkewCentrosymmetricMatrix( {} );
     81 // returns false
     82 
     83 out = isSkewCentrosymmetricMatrix( null );
     84 // returns false
     85 ```
     86 
     87 </section>
     88 
     89 <!-- /.examples -->
     90 
     91 <section class="links">
     92 
     93 [centrosymmetric-matrix]: https://en.wikipedia.org/wiki/Centrosymmetric_matrix
     94 
     95 </section>
     96 
     97 <!-- /.links -->