chore: stuff from code review

Author: aayush0325

lib/node_modules/@stdlib/math/base/special/cabsf/benchmark/c/benchmark.c

@@ -91,9 +91,9 @@ static float rand_float( void ) {
 static double benchmark( void ) {
 	float complex z;
 	double elapsed;
+	double t;
 	float re;
 	float im;
-	double t;
 	float y;
 	int i;
 

lib/node_modules/@stdlib/math/base/special/cabsf/benchmark/c/native/benchmark.c

@@ -95,8 +95,8 @@ static double benchmark( void ) {
 	double elapsed;
 	float re[ 100 ];
 	float im[ 100 ];
-	float y;
 	double t;
+	float y;
 	int i;
 
 	for ( i = 0; i < 100; i++ ) {

lib/node_modules/@stdlib/math/base/special/cabsf/benchmark/julia/benchmark.jl

@@ -16,58 +16,129 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import JSON
+import BenchmarkTools
+using Printf
+
+# Benchmark variables:
+name = "cabsf";
+repeats = 3;
 
 """
-    gen( re, im, name )
+	print_version()
+
+Prints the TAP version.
 
-Generate fixture data and write to file.
+# Examples
+
+``` julia
+julia> print_version()
+```
+"""
+function print_version()
+	@printf( "TAP version 13\n" );
+end
+
+"""
+	print_summary( total, passing )
+
+Print the benchmark summary.
 
 # Arguments
 
-* `re`: domain (real components)
-* `im`: domain (imaginary components)
-* `name::AbstractString`: output filename
+* `total`: total number of tests
+* `passing`: number of passing tests
 
 # Examples
 
 ``` julia
-julia> re = range( -1.0, stop = 1.0, length = 2001 );
-julia> im = range( -1.0, stop = 1.0, length = 2001 );
-julia> gen( re, im, \"data.json\" );
+julia> print_summary( 3, 3 )
 ```
 """
-function gen( re, im, name )
-	z = complex.( re, im );
-	y = Array{Float32}( undef, length(z) );
-	for i in eachindex(z)
-		y[i] = abs( ComplexF32( z[i] ) );
-	end
+function print_summary( total, passing )
+	@printf( "#\n" );
+	@printf( "1..%d\n", total ); # TAP plan
+	@printf( "# total %d\n", total );
+	@printf( "# pass  %d\n", passing );
+	@printf( "#\n" );
+	@printf( "# ok\n" );
+end
+
+"""
+	print_results( iterations, elapsed )
+
+Print benchmark results.
+
+# Arguments
+
+* `iterations`: number of iterations
+* `elapsed`: elapsed time (in seconds)
+
+# Examples
+
+``` julia
+julia> print_results( 1000000, 0.131009101868 )
+```
+"""
+function print_results( iterations, elapsed )
+	rate = iterations / elapsed
 
-	# Store data to be written to file as a collection:
-	data = Dict([
-		("re", re),
-		("im", im),
-		("expected", y)
-	]);
-
-	# Based on the script directory, create an output filepath:
-	filepath = joinpath( dir, name );
-
-	# Write the data to the output filepath as JSON:
-	outfile = open( filepath, "w" );
-	write( outfile, JSON.json(data) );
-	write( outfile, "\n" );
-	close( outfile );
+	@printf( "  ---\n" );
+	@printf( "  iterations: %d\n", iterations );
+	@printf( "  elapsed: %0.9f\n", elapsed );
+	@printf( "  rate: %0.9f\n", rate );
+	@printf( "  ...\n" );
 end
 
-# Get the filename:
-file = @__FILE__;
+"""
+	benchmark()
+
+Run a benchmark.
+
+# Notes
+
+* Benchmark results are returned as a two-element array: [ iterations, elapsed ].
+* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation.
+* The elapsed time is in seconds.
+
+# Examples
+
+``` julia
+julia> out = benchmark();
+```
+"""
+function benchmark()
+	t = BenchmarkTools.@benchmark abs( ComplexF32( (rand()*1000.0) - 500.0, (rand()*1000.0) - 500.0 ) ) samples=1e6
+
+	# Compute the total "elapsed" time and convert from nanoseconds to seconds:
+	s = sum( t.times ) / 1.0e9;
+
+	# Determine the number of "iterations":
+	iter = length( t.times );
 
-# Extract the directory in which this file resides:
-dir = dirname( file );
+	# Return the results:
+	[ iter, s ];
+end
+
+"""
+	main()
+
+Run benchmarks.
+
+# Examples
+
+``` julia
+julia> main();
+```
+"""
+function main()
+	print_version();
+	for i in 1:repeats
+		@printf( "# julia::%s\n", name );
+		results = benchmark();
+		print_results( results[ 1 ], results[ 2 ] );
+		@printf( "ok %d benchmark finished\n", i );
+	end
+	print_summary( repeats, repeats );
+end
 
-# Generate fixture data:
-re = range( -1000.0, stop = 1000.0, length = 2003 );
-im = range( -1000.0, stop = 1000.0, length = 2003 );
-gen( re, im, "data.json" );
+main();

lib/node_modules/@stdlib/math/base/special/cabsf/benchmark/julia/data.json

@@ -38,8 +38,11 @@ julia> gen( re, im, \"data.json\" );
 ```
 """
 function gen( re, im, name )
- 	z = Complex{ Float32 }.( Float32.( re ), Float32.( im ) );
-	y = abs.( z );
+	z = complex.( re, im );
+	y = Array{Float32}( undef, length(z) );
+	for i in eachindex(z)
+		y[i] = abs( ComplexF32( z[i] ) );
+	end
 
 	# Store data to be written to file as a collection:
 	data = Dict([