time-to-botec

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

README.md (4155B)

      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2021 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 # ndarray Native Add-ons
     22 
     23 > C APIs for creating Node-API ndarray native add-ons.
     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 This package exposes an absolute file path for the directory containing header files for various C APIs. The various C APIs facilitate the creation of Node-API ndarray native add-ons.
     30 
     31 </section>
     32 
     33 <!-- /.intro -->
     34 
     35 <!-- Package usage documentation. -->
     36 
     37 <section class="usage">
     38 
     39 ## Usage
     40 
     41 ```javascript
     42 var headerDir = require( '@stdlib/ndarray/base/napi' );
     43 ```
     44 
     45 #### headerDir
     46 
     47 Absolute file path for the directory containing header files for C APIs.
     48 
     49 ```javascript
     50 var dir = headerDir;
     51 // returns <string>
     52 ```
     53 
     54 </section>
     55 
     56 <!-- /.usage -->
     57 
     58 <!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
     59 
     60 <section class="notes">
     61 
     62 </section>
     63 
     64 <!-- /.notes -->
     65 
     66 <!-- Package usage examples. -->
     67 
     68 <section class="examples">
     69 
     70 ## Examples
     71 
     72 ```javascript
     73 var headerDir = require( '@stdlib/ndarray/base/napi' );
     74 
     75 console.log( headerDir );
     76 // => <string>
     77 ```
     78 
     79 </section>
     80 
     81 <!-- /.examples -->
     82 
     83 <!-- C interface documentation. -->
     84 
     85 * * *
     86 
     87 <section class="c">
     88 
     89 ## C APIs
     90 
     91 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
     92 
     93 <section class="intro">
     94 
     95 This package exposes various C APIs to facilitate the creation of Node-API ndarray native add-ons. The included C APIs are the APIs implemented in the following packages:
     96 
     97 <!-- NOTE: please keep in alphabetical order -->
     98 
     99 -   [`@stdlib/ndarray/base/napi/unary`][@stdlib/ndarray/base/napi/unary]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/base/napi/unary`][@stdlib/ndarray/base/napi/unary
    100 -   [`@stdlib/ndarray/base/unary`][@stdlib/ndarray/base/unary]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/base/unary`][@stdlib/ndarray/base/unary
    101 -   [`@stdlib/ndarray/dtypes`][@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/dtypes`][@stdlib/ndarray/dtypes
    102 
    103 For API documentation, consult the individual packages.
    104 
    105 </section>
    106 
    107 <!-- /.intro -->
    108 
    109 <!-- C usage documentation. -->
    110 
    111 <section class="usage">
    112 
    113 ### Usage
    114 
    115 ```c
    116 #include "stdlib/ndarray/base/napi.h"
    117 ```
    118 
    119 </section>
    120 
    121 <!-- /.usage -->
    122 
    123 <!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
    124 
    125 <section class="notes">
    126 
    127 </section>
    128 
    129 <!-- /.notes -->
    130 
    131 <!-- C API usage examples. -->
    132 
    133 <section class="examples">
    134 
    135 ### Examples
    136 
    137 ```c
    138 #include "stdlib/ndarray/base/napi.h"
    139 
    140 // TODO
    141 ```
    142 
    143 </section>
    144 
    145 <!-- /.examples -->
    146 
    147 </section>
    148 
    149 <!-- /.c -->
    150 
    151 <!-- 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. -->
    152 
    153 <section class="references">
    154 
    155 </section>
    156 
    157 <!-- /.references -->
    158 
    159 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
    160 
    161 <section class="links">
    162 
    163 [@stdlib/ndarray/base/napi/unary]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/base/napi/unary
    164 
    165 [@stdlib/ndarray/base/unary]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/base/unary
    166 
    167 [@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/dtypes
    168 
    169 </section>
    170 
    171 <!-- /.links -->