Updated POD, renamed function

Renamed PerlOMP_VERIFY_1D_CHAR_ARRAY to PerlOMP_VERIFY_1D_STRING_ARRAY.

Author: oodler577

Changes

@@ -86,3 +86,8 @@
       - updated documentation
       - added Github initial CI testing for latest Ubuntu,
       - added VERIFY C functions (see POD)
+
+0.2.1  03/05/2025 11:08:00 PM MST
+      - updated POD
+      - renamed, "PerlOMP_VERIFY_1D_CHAR_ARRAY" to
+        "PerlOMP_VERIFY_1D_STRING_ARRAY" for consistency

lib/OpenMP/Simple.pm

@@ -4,7 +4,7 @@ use strict;
 use warnings;
 use Alien::OpenMP;
 
-our $VERSION = q{0.2.0};
+our $VERSION = q{0.2.1};
 
 # This module is a wrapper around a ".h" file that is injected into Alien::OpenMP
 # via Inline:C's AUTO_INCLUDE feature. This header file constains C MACROs for reading
@@ -113,9 +113,7 @@ All MACROS have at least 1 test in the suite. Please look at these in the
 Github repository to get an idea of how to use C<OpenMP::Simple>'s macros
 with C<OpenMP::Environment>.
 
-=over 4
-
-=item C<PerlOMP_GETENV_BASIC>
+=head3 C<PerlOMP_GETENV_BASIC>
 
 Equivalent of using,
 
@@ -126,225 +124,211 @@ The purpose of this bundled approach is to make it easier to get started
 quickly. This list may be updated between versions. This is the recommended
 one to use when starting with this module. See the L<SYNOPSIS> example.
 
-=item C<PerlOMP_UPDATE_WITH_ENV__NUM_THREADS>
+=head3 C<PerlOMP_UPDATE_WITH_ENV__NUM_THREADS>
 
 Updates the OpenMP runtime with the value of the environmental
 variable, C<$ENV{OMP_NUM_THREADS}>, which is managed via
 C<< OpenMP::Environment->omp_num_threads[int numThreads]); >>.
 
-=item C<PerlOMP_UPDATE_WITH_ENV__DEFAULT_DEVICE>
+=head3 C<PerlOMP_UPDATE_WITH_ENV__DEFAULT_DEVICE>
 
 Updates the OpenMP runtime with the value of the environmental
 variable, C<$ENV{OMP_DEFAULT_DEVICE}>, which is managed
 via C<< OpenMP::Environment->omp_default_device([int deviceNo]); >>.
 
-=item C<PerlOMP_UPDATE_WITH_ENV__MAX_ACTIVE_LEVELS>
+=head3 C<PerlOMP_UPDATE_WITH_ENV__MAX_ACTIVE_LEVELS>
 
 Updates the OpenMP runtime with the value of the environmental
 variable, C<$ENV{OMP_MAX_ACTIVE_LEVELS}>, which is managed
 via C<< OpenMP::Environment->omp_max_active_levels([int maxLevel]); >>.
 
-=item C<PerlOMP_UPDATE_WITH_ENV__DYNAMIC>
+=head3 C<PerlOMP_UPDATE_WITH_ENV__DYNAMIC>
 
 Updates the OpenMP runtime with the value of the environmental
 variable, C<$ENV{OMP_DYNAMIC}>, which is managed
 via C<< OpenMP::Environment->omp_dynamic(['true'|'false']); >>.
 
-=item C<PerlOMP_UPDATE_WITH_ENV__NESTED>
+=head3 C<PerlOMP_UPDATE_WITH_ENV__NESTED>
 
 Updates the OpenMP runtime with the value of the environmental
 variable, C<$ENV{OMP_NESTED}>, which is managed
 via C<< OpenMP::Environment->omp_nested(['true'|'false']); >>.
 
-=item C<PerlOMP_UPDATE_WITH_ENV__SCHEDULE>
+=head3 C<PerlOMP_UPDATE_WITH_ENV__SCHEDULE>
 
 Updates the OpenMP runtime with the value of the environmental
 variable, C<$ENV{OMP_SCHEDULE}>, which is managed
 via C<< OpenMP::Environment->omp_schedule(...); >>.
 
 Note: The schedule syntax is of the form I<schedule[;chunkSize]>.
 
-=item C<PerlOMP_UPDATE_WITH_ENV__TEAMS_THREAD_LIMIT>
+=head3 C<PerlOMP_UPDATE_WITH_ENV__TEAMS_THREAD_LIMIT>
 
 Updates the OpenMP runtime with the value of the environmental
 variable, C<$ENV{OMP_TEAMS_THREAD_LIMIT}>, which is managed via C<< OpenMP::Environment->omp_([int limit]); >>.
 
 Note: C<OMP_TEAMS_THREAD_LIMIT> is not supported until GCC 12.3.0
 
-=item C<PerlOMP_UPDATE_WITH_ENV__NUM_TEAMS>
+=head3 C<PerlOMP_UPDATE_WITH_ENV__NUM_TEAMS>
 
 Updates the OpenMP runtime with the value of the environmental variable,
 C<$ENV{OMP_NUM_TEAMS}>, which is managed via C<< OpenMP::Environment->omp_([int num]); >>.
 
 Note: C<OMP_NUM_TEAMS> is not supported until GCC 12.3.0
 
-=item C<PerlOMP_RET_ARRAY_REF_ret>
+=head3 C<PerlOMP_RET_ARRAY_REF_ret>
 
 (may not be needed) - creates a new C<AV*> and sets it I<mortal> (doesn't
 survive outside of the current scope). Used when wanting to return an array
 reference that's been populated via C<av_push>.
 
-=back
-
 =head1 PROVIDED PERL ARRAY COUNTING FUNCTIONS
 
-=over 4
-
-=item C<int PerlOMP_1D_Array_NUM_ELEMENTS (SV *AVref)>
+=head2 C<int PerlOMP_1D_Array_NUM_ELEMENTS (SV *AVref)>
 
 Returns the integer count of number of elements in the array reference. The 
 functino doesn't care what is in the elements.
 
-=item C<int PerlOMP_2D_AoA_NUM_ROWS(SV *AoAref)>
+=head2 C<int PerlOMP_2D_AoA_NUM_ROWS(SV *AoAref)>
 
 Returns the integer count of number of rows in a 2D array reference. The
 fucntion doesn't care what the rows looks like or what is in them
 
-=item C<int PerlOMP_2D_AoA_NUM_COLS(SV *AoAref)>
+=head2 C<int PerlOMP_2D_AoA_NUM_COLS(SV *AoAref)>
 
 Returns the number of elements in the first row of the provided 2D array
 reference. It assumes all rows are the same. It doesn't verify the contents
 of each row.
 
-=back
-
 =head1 PROVIDED PERL TO C CONVERSION FUNCTIONS
 
 B<Note>: Work is currently focused on finding the true limits of the Perl C
 API. It is likely that in a lot of cases, elements in Perl Arrays (AV) and Perl
 Hashes (HV) maybe accessed safely without first transferring the entire data
 structures into its pure C<C> equivalent.
 
-=over 4
-
-=item C<PerlOMP_1D_Array_TO_1D_FLOAT_ARRAY>
+=head2 C<PerlOMP_1D_Array_TO_1D_FLOAT_ARRAY>
 
   void PerlOMP_1D_Array_TO_1D_FLOAT_ARRAY(SV *AVref, int numElements, float retArray[numElements]);
 
 Converts a 1D Perl Array Reference (C<AV*>) into a 1D C array of floats. This function assumes the Perl array contains numeric floating point values.
 
-=item C<PerlOMP_1D_Array_TO_1D_FLOAT_ARRAY_r>
+=head2 C<PerlOMP_1D_Array_TO_1D_FLOAT_ARRAY_r>
 
   void PerlOMP_1D_Array_TO_1D_FLOAT_ARRAY_r(SV *AVref, int numElements, float retArray[numElements]);
 
 The parallelized version of C<PerlOMP_1D_Array_TO_1D_FLOAT_ARRAY> using OpenMP. This function performs the same operation, but the array conversion is parallelized with OpenMP.
 
-=item C<PerlOMP_1D_Array_TO_1D_INT_ARRAY>
+=head2 C<PerlOMP_1D_Array_TO_1D_INT_ARRAY>
 
   void PerlOMP_1D_Array_TO_1D_INT_ARRAY(SV *AVref, int numElements, int retArray[numElements]);
 
 Converts a 1D Perl Array Reference (C<AV*>) into a 1D C array of integers. This function assumes the Perl array contains integer values.
 
-=item C<PerlOMP_1D_Array_TO_1D_INT_ARRAY_r>
+=head2 C<PerlOMP_1D_Array_TO_1D_INT_ARRAY_r>
 
   void PerlOMP_1D_Array_TO_1D_INT_ARRAY_r(SV *AVref, int numElements, int retArray[numElements]);
 
 The parallelized version of C<PerlOMP_1D_Array_TO_1D_INT_ARRAY> using OpenMP. This function performs the same operation, but the array conversion is parallelized with OpenMP.
 
-=item C<PerlOMP_1D_Array_TO_1D_STRING_ARRAY>
+=head2 C<PerlOMP_1D_Array_TO_1D_STRING_ARRAY>
 
   void PerlOMP_1D_Array_TO_1D_STRING_ARRAY(SV *AVref, int numElements, char *retArray[numElements]);
 
 Converts a 1D Perl Array Reference (C<AV*>) into a 1D C array of strings. The Perl array should contain string values.
 
-=item C<PerlOMP_1D_Array_TO_1D_STRING_ARRAY_r>
+=head2 C<PerlOMP_1D_Array_TO_1D_STRING_ARRAY_r>
 
   void PerlOMP_1D_Array_TO_1D_STRING_ARRAY_r(SV *AVref, int numElements, char *retArray[numElements]);
 
 The parallelized version of C<PerlOMP_1D_Array_TO_1D_STRING_ARRAY> using OpenMP. This function performs the same operation, but the array conversion is parallelized with OpenMP.
 
-=item C<PerlOMP_2D_AoA_TO_2D_FLOAT_ARRAY>
+=head2 C<PerlOMP_2D_AoA_TO_2D_FLOAT_ARRAY>
 
   void PerlOMP_2D_AoA_TO_2D_FLOAT_ARRAY(SV *AoA, int numRows, int rowSize, float retArray[numRows][rowSize]);
 
 Converts a 2D Array of Arrays (AoA) in Perl into a 2D C array of floats. The Perl array should be an array of arrays, where each inner array contains floating point values.
 
-=item C<PerlOMP_2D_AoA_TO_2D_FLOAT_ARRAY_r>
+=head2 C<PerlOMP_2D_AoA_TO_2D_FLOAT_ARRAY_r>
 
   void PerlOMP_2D_AoA_TO_2D_FLOAT_ARRAY_r(SV *AoA, int numRows, int rowSize, float retArray[numRows][rowSize]);
 
 The parallelized version of C<PerlOMP_2D_AoA_TO_2D_FLOAT_ARRAY> using OpenMP. This function performs the same operation, but the array conversion is parallelized with OpenMP.
 
-=item C<PerlOMP_2D_AoA_TO_2D_INT_ARRAY>
+=head2 C<PerlOMP_2D_AoA_TO_2D_INT_ARRAY>
 
   void PerlOMP_2D_AoA_TO_2D_INT_ARRAY(SV *AoA, int numRows, int rowSize, int retArray[numRows][rowSize]);
 
 Converts a 2D Array of Arrays (AoA) in Perl into a 2D C array of integers. The Perl array should be an array of arrays, where each inner array contains integer values.
 
-=item C<PerlOMP_2D_AoA_TO_2D_INT_ARRAY_r>
+=head2 C<PerlOMP_2D_AoA_TO_2D_INT_ARRAY_r>
 
   void PerlOMP_2D_AoA_TO_2D_INT_ARRAY_r(SV *AoA, int numRows, int rowSize, int retArray[numRows][rowSize]);
 
 The parallelized version of C<PerlOMP_2D_AoA_TO_2D_INT_ARRAY> using OpenMP. This function performs the same operation, but the array conversion is parallelized with OpenMP.
 
-=item C<PerlOMP_2D_AoA_TO_2D_STRING_ARRAY>
+=head2 C<PerlOMP_2D_AoA_TO_2D_STRING_ARRAY>
 
   void PerlOMP_2D_AoA_TO_2D_STRING_ARRAY(SV *AoA, int numRows, int rowSize, char *retArray[numRows][rowSize]);
   
 Converts a 2D Array of Arrays (AoA) in Perl into a 2D C array of strings. The Perl array should be an array of arrays, where each inner array contains string values.
 
-=item C<PerlOMP_2D_AoA_TO_2D_STRING_ARRAY_r>
+=head2 C<PerlOMP_2D_AoA_TO_2D_STRING_ARRAY_r>
 
   void PerlOMP_2D_AoA_TO_2D_STRING_ARRAY_r(SV *AoA, int numRows, int rowSize, char *retArray[numRows][rowSize]);
   
 The parallelized version of C<PerlOMP_2D_AoA_TO_2D_STRING_ARRAY> using OpenMP. This function performs the same operation, but the array conversion is parallelized with OpenMP.
 
-=back
-
 =head1 PROVIDED ARRAY MEMBER VERIFICATION FUNCTIONS
 
-=over 4
-
-=item C<PerlOMP_VERIFY_1D_Array>
+=head2 C<PerlOMP_VERIFY_1D_Array>
 
   void PerlOMP_VERIFY_1D_Array(SV* array);
 
 Verifies that the given Perl variable is a valid 1D array reference.
 
-=item C<PerlOMP_VERIFY_1D_INT_ARRAY>
+=head2 C<PerlOMP_VERIFY_1D_INT_ARRAY>
 
   void PerlOMP_VERIFY_1D_INT_ARRAY(SV* array);
 
 Verifies that the given 1D array contains only integer values.
 
-=item C<PerlOMP_VERIFY_1D_FLOAT_ARRAY>
+=head2 C<PerlOMP_VERIFY_1D_FLOAT_ARRAY>
 
   void PerlOMP_VERIFY_1D_FLOAT_ARRAY(SV* array);
 
 Verifies that the given 1D array contains only floating-point values.
 
-=item C<PerlOMP_VERIFY_1D_CHAR_ARRAY>
+=head2 C<PerlOMP_VERIFY_1D_CHAR_ARRAY>
 
   void PerlOMP_VERIFY_1D_CHAR_ARRAY(SV* array);
 
 Verifies that the given 1D array contains only string values.
 
-=item C<PerlOMP_VERIFY_2D_AoA>
+=head2 C<PerlOMP_VERIFY_2D_AoA>
 
   void PerlOMP_VERIFY_2D_AoA(SV* array);
 
 Verifies that the given Perl variable is a valid 2D array of arrays (AoA) reference.
 
-=item C<PerlOMP_VERIFY_2D_INT_ARRAY>
+=head2 C<PerlOMP_VERIFY_2D_INT_ARRAY>
 
   void PerlOMP_VERIFY_2D_INT_ARRAY(SV* array);
 
 Verifies that the given 2D array contains only integer values.
 
-=item C<PerlOMP_VERIFY_2D_FLOAT_ARRAY>
+=head2 C<PerlOMP_VERIFY_2D_FLOAT_ARRAY>
 
   void PerlOMP_VERIFY_2D_FLOAT_ARRAY(SV* array);
 
 Verifies that the given 2D array contains only floating-point values.
 
-=item C<PerlOMP_VERIFY_2D_STRING_ARRAY>
+=head2 C<PerlOMP_VERIFY_2D_STRING_ARRAY>
 
   void PerlOMP_VERIFY_2D_STRING_ARRAY(SV* array);
 
 Verifies that the given 2D array contains only string values.
 
-=back
-
 =head1 SEE ALSO
 
 This is a module that aims at making it easier to bootstrap Perl+OpenMP

share/openmp-simple.h

@@ -478,7 +478,7 @@ void verify_1D_array_type(SV *array, bool (*type_check)(SV *), const char *type_
 void PerlOMP_VERIFY_1D_FLOAT_ARRAY(SV *array) { verify_1D_array_type(array, is_float, "float"); }
 void PerlOMP_VERIFY_1D_INT_ARRAY(SV *array) { verify_1D_array_type(array, is_int, "integer"); }
 void PerlOMP_VERIFY_1D_DOUBLE_ARRAY(SV *array) { verify_1D_array_type(array, is_float, "double"); }
-void PerlOMP_VERIFY_1D_CHAR_ARRAY(SV *array) { verify_1D_array_type(array, is_string, "string"); }
+void PerlOMP_VERIFY_1D_STRING_ARRAY(SV *array) { verify_1D_array_type(array, is_string, "string"); }
 
 /* Check for mixed types */
 void PerlOMP_VERIFY_1D_MIXED_ARRAY(SV *array) {

t/00-PerlOMP_VERIFY.t

@@ -12,11 +12,11 @@ use Test::Exception;
 
 my $valid_1d_int = [1, 2, 3, 4, 5];
 my $valid_1d_float = [1.1, 2.2, 3.3, 4.4, 5.5];
-my $valid_1d_string = ["a", "b", "c", "d"];
+my $valid_1d_string = ["ant", "bat", "cat", "dog"];
 
 my $valid_2d_int = [[1, 2], [3, 4], [5, 6]];
 my $valid_2d_float = [[1.1, 2.2], [3.3, 4.4], [5.5, 6.6]];
-my $valid_2d_string = [["a", "b"], ["c", "d"], ["e", "f"]];
+my $valid_2d_string = [["ark", "bar"], ["car", "day"], ["egg", "fly"]];
 
 my $invalid_scalar = 42;
 my $invalid_1d_array = { key => "value" };
@@ -31,8 +31,8 @@ dies_ok { _PerlOMP_VERIFY_1D_INT_ARRAY($valid_1d_float) } "Float 1D array should
 lives_ok { _PerlOMP_VERIFY_1D_FLOAT_ARRAY($valid_1d_float) } "Valid 1D float array";
 dies_ok { _PerlOMP_VERIFY_1D_FLOAT_ARRAY($valid_1d_int) } "Int 1D array should fail float verification";
 
-lives_ok { _PerlOMP_VERIFY_1D_CHAR_ARRAY($valid_1d_string) } "Valid 1D string array";
-dies_ok { _PerlOMP_VERIFY_1D_CHAR_ARRAY($valid_1d_int) } "Int 1D array should fail string verification";
+lives_ok { _PerlOMP_VERIFY_1D_STRING_ARRAY($valid_1d_string) } "Valid 1D string array";
+dies_ok { _PerlOMP_VERIFY_1D_STRING_ARRAY($valid_1d_int) } "Int 1D array should fail string verification";
 
 # Verify 2D arrays
 dies_ok { _PerlOMP_VERIFY_2D_AoA($invalid_scalar) } "Scalar should not be a valid 2D array";
@@ -55,7 +55,7 @@ __C__
 void _PerlOMP_VERIFY_1D_Array(SV* array) { PerlOMP_VERIFY_1D_Array(array); }
 void _PerlOMP_VERIFY_1D_INT_ARRAY(SV* array) { PerlOMP_VERIFY_1D_INT_ARRAY(array); }
 void _PerlOMP_VERIFY_1D_FLOAT_ARRAY(SV* array) { PerlOMP_VERIFY_1D_FLOAT_ARRAY(array); }
-void _PerlOMP_VERIFY_1D_CHAR_ARRAY(SV* array) { PerlOMP_VERIFY_1D_CHAR_ARRAY(array); }
+void _PerlOMP_VERIFY_1D_STRING_ARRAY(SV* array) { PerlOMP_VERIFY_1D_STRING_ARRAY(array); }
 void _PerlOMP_VERIFY_2D_AoA(SV* array) { PerlOMP_VERIFY_2D_AoA(array); }
 void _PerlOMP_VERIFY_2D_INT_ARRAY(SV* array) { PerlOMP_VERIFY_2D_INT_ARRAY(array); }
 void _PerlOMP_VERIFY_2D_FLOAT_ARRAY(SV* array) { PerlOMP_VERIFY_2D_FLOAT_ARRAY(array); }