time-to-botec

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

README.md (1712B)

      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 # isCircularArray
     22 
     23 > Test if a value is an array containing a circular reference.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var isCircularArray = require( '@stdlib/assert/is-circular-array' );
     31 ```
     32 
     33 #### isCircularArray( value )
     34 
     35 Tests if a `value` is an `array` containing a circular reference.
     36 
     37 ```javascript
     38 var arr = [ 1, 2, 3 ];
     39 var bool = isCircularArray( arr );
     40 // returns false
     41 
     42 arr.push( arr );
     43 bool = isCircularArray( arr );
     44 // returns true
     45 
     46 arr.pop();
     47 arr.self = arr;
     48 bool = isCircularArray( arr );
     49 // returns true
     50 ```
     51 
     52 </section>
     53 
     54 <!-- /.usage -->
     55 
     56 <section class="examples">
     57 
     58 ## Examples
     59 
     60 <!-- eslint no-undef: "error" -->
     61 
     62 ```javascript
     63 var isCircularArray = require( '@stdlib/assert/is-circular-array' );
     64 
     65 var arr = [ 1, 2, 3 ];
     66 arr.push( arr );
     67 console.log( isCircularArray( arr ) );
     68 // => true
     69 
     70 var obj = {
     71     'beep': 'boop'
     72 };
     73 obj.self = obj;
     74 console.log( isCircularArray( obj ) );
     75 // => false
     76 
     77 console.log( isCircularArray( [] ) );
     78 // => false
     79 
     80 console.log( isCircularArray( null ) );
     81 // => false
     82 ```
     83 
     84 </section>
     85 
     86 <!-- /.examples -->
     87 
     88 <section class="links">
     89 
     90 </section>
     91 
     92 <!-- /.links -->