stdlib_io: add print_array function to print arrays to output units
#981
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This pull request adds a new subroutine specification, print_array, to the stdlib_io module for printing 2D arrays to an output unit.
- Introduces detailed documentation covering the subroutine’s syntax, argument descriptions, and an example.
- Specifies default behaviors for output unit, delimiter, format, and brief mode.
Files not reviewed (7)
- example/io/CMakeLists.txt: Language not supported
- example/io/example_print_array.f90: Language not supported
- src/CMakeLists.txt: Language not supported
- src/stdlib_io.fypp: Language not supported
- src/stdlib_io_print_array.fypp: Language not supported
- test/io/CMakeLists.txt: Language not supported
- test/io/test_print_array.f90: Language not supported
This was referenced Apr 20, 2025
jvdp1
reviewed
Apr 23, 2025
doc/specs/stdlib_io.md
Outdated
|
|
||
| `delimiter`: Shall be a character string of length 1 containing the delimiter between array elements. It is an `intent(in)` argument. The default is a `" "` (space). | ||
|
|
||
| `brief`: Shall be a logical flag. If `.true.`, the array is printed in a brief format. The default is `.true.`. |
There was a problem hiding this comment.
what is a "brief" format? Could you maybe provide a short definition?
There was a problem hiding this comment.
Okay. Details of the "brief" format were added, and an example was deliberately provided to illustrate the usage of the "brief" format.
| @@ -305,3 +305,38 @@ Exceptions trigger an `error stop` unless the optional `err` argument is provide | |||
| {!example/io/example_get_file.f90!} | |||
| ``` | |||
|
|
|||
| ## `print_array` - Print an array to an output unit | |||
There was a problem hiding this comment.
Minor comment: the name could be discussed with the community. Personally, I would prefer disp.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add
print_arraysubroutine, which is used to print two-dimensional arrays of integer and floating-point types. These two types are more commonly used in Fortran. It supports arguments such as delimiter, output unit, output format, and whether to print briefly.In the non-brief output mode, the print_array function can produce an output result style similar to that of
savetxtin stdlib_io. The print_array function is mainly convenient for users to output to the screen (standard output) and is likely to be mostly used for code debugging.Prior Art:
This PR will replace #520, and is related to #40, but is not sufficient to close #40.
Remaining to be discussed
print_array, it also includes thesavetxtroutine in stdlib_io.