Auto-generated commit

.gitattributes

@@ -40,10 +40,27 @@
 *.mov binary
 
 # Override what is considered "vendored" by GitHub's linguist:
-/deps/** linguist-vendored=false
-/lib/node_modules/** linguist-vendored=false linguist-generated=false
-test/fixtures/** linguist-vendored=false
-tools/** linguist-vendored=false
+/lib/node_modules/** -linguist-vendored -linguist-generated
 
-# Override what is considered "documentation" by GitHub's linguist:
-examples/** linguist-documentation=false
+# Configure directories which should *not* be included in GitHub language statistics:
+/deps/** linguist-vendored
+/dist/** linguist-generated
+/workshops/** linguist-vendored
+
+benchmark/** linguist-vendored
+docs/* linguist-documentation
+etc/** linguist-vendored
+examples/** linguist-documentation
+scripts/** linguist-vendored
+test/** linguist-vendored
+tools/** linguist-vendored
+
+# Configure files which should *not* be included in GitHub language statistics:
+Makefile linguist-vendored
+*.mk linguist-vendored
+*.jl linguist-vendored
+*.py linguist-vendored
+*.R linguist-vendored
+
+# Configure files which should be included in GitHub language statistics:
+docs/types/*.d.ts -linguist-documentation

CONTRIBUTORS

@@ -19,6 +19,7 @@ Chinmay Joshi <[email protected]>
 Christopher Dambamuromo <[email protected]>
 Dan Rose <[email protected]>
 Daniel Killenberger <[email protected]>
+Daniel Yu <[email protected]>
 Dominik Moritz <[email protected]>
 Dorrin Sotoudeh <[email protected]>
 EuniceSim142 <[email protected]>

README.md

@@ -203,6 +203,101 @@ console.log( out );
 
 <!-- /.examples -->
 
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/blas/base/dasum.h"
+```
+
+#### c_dasum( N, X, stride )
+
+Computes the sum of absolute values.
+
+```c
+const double x[] = { 1.0, 2.0, 3.0, 4.0 };
+
+double v = c_dasum( 4, x, 1 );
+// returns 10.0
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **X**: `[in] void*` input array.
+-   **stride**: `[in] CBLAS_INT` index increment for `X`.
+
+```c
+double c_dasum( const CBLAS_INT N, const double *X, const CBLAS_INT stride );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/blas/base/dasum.h"
+#include <stdio.h>
+
+int main( void ) {
+    // Create a strided array:
+    const double x[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 };
+
+    // Specify the number of elements:
+    const int N = 8;
+
+    // Specify a stride:
+    const int strideX = 1;
+
+    // Compute the sum of absolute values:
+    double sum = c_dasum( N, x, strideX );
+
+    // Print the result:
+    printf( "sum: %lf\n", sum );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
 <section class="related">

benchmark/c/benchmark.length.c

@@ -16,9 +16,6 @@
 * limitations under the License.
 */
 
-/**
-* Benchmark `dasum`.
-*/
 #include "stdlib/blas/base/dasum.h"
 #include <stdlib.h>
 #include <stdio.h>

benchmark/fortran/benchmark.length.f

@@ -16,13 +16,6 @@
 ! limitations under the License.
 !<
 
-!> Benchmark `dasum`.
-!
-! ## Notes
-!
-! -   Written in "free form" Fortran 95.
-!
-!<
 program bench
   implicit none
   ! ..
@@ -214,4 +207,4 @@ subroutine main()
     end do
     call print_summary( count, count )
   end subroutine main
-end program bench
+end program bench

include/stdlib/blas/base/dasum.h

@@ -22,6 +22,8 @@
 #ifndef DASUM_H
 #define DASUM_H
 
+#include "stdlib/blas/base/shared.h"
+
 /*
 * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
 */
@@ -32,7 +34,7 @@ extern "C" {
 /**
 * Computes the sum of absolute values.
 */
-double c_dasum( const int N, const double *X, const int stride );
+double c_dasum( const CBLAS_INT N, const double *X, const CBLAS_INT stride );
 
 #ifdef __cplusplus
 }

include/stdlib/blas/base/dasum_cblas.h

@@ -22,6 +22,8 @@
 #ifndef DASUM_CBLAS_H
 #define DASUM_CBLAS_H
 
+#include "stdlib/blas/base/shared.h"
+
 /*
 * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
 */
@@ -32,7 +34,7 @@ extern "C" {
 /**
 * Computes the sum of absolute values.
 */
-double cblas_dasum( const int N, const double *X, const int stride );
+double cblas_dasum( const CBLAS_INT N, const double *X, const CBLAS_INT stride );
 
 #ifdef __cplusplus
 }