| title |
|---|
io |
[TOC]
Experimental
Loads a rank-2 array from a text file.
call [[stdlib_io(module):loadtxt(interface)]] (filename, array [, skiprows] [, max_rows] [, fmt])
filename: Shall be a character expression containing the file name from which to load the rank-2 array.
array: Shall be an allocatable rank-2 array of type real, complex or integer.
skiprows (optional): Skip the first skiprows lines. If skipping more rows than present, a 0-sized array will be returned. The default is 0.
max_rows (optional): Read max_rows lines of content after skiprows lines. A negative value results in reading all lines. A value of zero results in no lines to be read. The default value is -1.
fmt (optional): Fortran format specifier for the text read. Defaults to the write format for the data type. Setting fmt='*' will specify list directed read.
Returns an allocated rank-2 array with the content of filename.
{!example/io/example_loadtxt.f90!}Experimental
Returns the unit number of a file opened to read, to write, or to read and write. The file might be a text file or a binary file. All files are opened using a streamed access.
u = [[stdlib_io(module):open(function)]] (filename [, mode] [, iostat])
filename: Shall be a character expression containing the name of the file to open.
mode (optional): Shall be a character expression containing characters describing the way in which the file will be used. The available modes are:
| Character | Meaning |
|---|---|
'r' |
open for reading (default) |
'w' |
open for writing, truncating the file first |
'x' |
open for exclusive creation, failing if the file already exists |
'a' |
open for writing, appending to the end of the file if it exists |
'+' |
open for updating (reading and writing) |
'b' |
binary mode |
't' |
text mode (default) |
The default mode is 'rt' (i.e. open for reading a text file). The mode may include one of the four different methods for opening a file (i.e., 'r', 'w', 'x', and 'a'). These four methods can be associated with the character '+' to open the file for updating. In addition, it can be specified if the file should be handled as a binary file ('b') or a text file ('t').
iostat (optional): Shall be a scalar of type integer that receives the error status of open, if provided. If no error exists, iostat is zero.
u: Shall be a scalar of type integer that specifies the unit number associated with the file filename.
The result is a scalar of type integer.
{!example/io/example_open.f90!}Experimental
Saves a rank-2 array into a text file.
call [[stdlib_io(module):savetxt(interface)]] (filename, array)
filename: Shall be a character expression containing the name of the file that will contain the 2D array.
array: Shall be a rank-2 array of type real, complex or integer.
Provides a text file called filename that contains the rank-2 array.
{!example/io/example_savetxt.f90!}Experimental
Loads an array from a npy formatted binary file.
call [[stdlib_io_np(module):load_npy(interface)]] (filename, array[, iostat][, iomsg])
filename: Shall be a character expression containing the file name from which to load the array.
This argument is intent(in).
array: Shall be an allocatable array of any rank of type real, complex or integer.
This argument is intent(out).
iostat: Default integer, contains status of loading to file, zero in case of success.
It is an optional argument, in case not present the program will halt for non-zero status.
This argument is intent(out).
iomsg: Deferred length character value, contains error message in case iostat is non-zero.
It is an optional argument, error message will be dropped if not present.
This argument is intent(out).
Returns an allocated array with the content of filename in case of success.
{!example/io/example_loadnpy.f90!}Experimental
Saves an array into a npy formatted binary file.
call [[stdlib_io_np(module):save_npy(interface)]] (filename, array[, iostat][, iomsg])
filename: Shall be a character expression containing the name of the file that will contain the array.
This argument is intent(in).
array: Shall be an array of any rank of type real, complex or integer.
This argument is intent(in).
iostat: Default integer, contains status of saving to file, zero in case of success.
It is an optional argument, in case not present the program will halt for non-zero status.
This argument is intent(out).
iomsg: Deferred length character value, contains error message in case iostat is non-zero.
It is an optional argument, error message will be dropped if not present.
This argument is intent(out).
Provides a npy file called filename that contains the rank-2 array.
{!example/io/example_savenpy.f90!}Experimental
Populates an array of array_wrapper_type with the contents of an npz file.
call [[stdlib_io_np(module):load_npz(interface)]] (filename, arrays[, iostat][, iomsg][, tmp_dir])
filename: Shall be a character expression containing the name of the npz file to load from. The argument is intent(in).
arrays: Shall be an allocatable array of type array_wrapper_type to load the content of the npz file to. This argument is intent(out).
iostat: Default integer, contains status of loading to file, zero in case of success. This argument is optional and intent(out).
iomsg: Deferred length character value, contains error message in case iostat is non-zero. It is an optional argument, error message will be dropped if not present. This argument is intent(out).
tmp_dir: Shall be a character expression containing the name of the temporary directory to extract the npz file to. The argument is optional and intent(in).
{!example/io/example_load_npz.f90!}Experimental
Saves an array of array_wrapper_type into a npz file.
call [[stdlib_io_np(module):save_npz(interface)]] (filename, arrays[, iostat][, iomsg][, compressed])
filename: Shall be a character expression containing the name of the file that contains the arrays. This argument is intent(in).
arrays: Shall be arrays of type array_wrapper_type that are meant to be saved to disk. This argument is intent(in).
iostat: Default integer, contains status of saving to file, zero in case of success. This argument is optional and intent(out).
iomsg: Deferred length character value, contains error message in case iostat is non-zero. It is an optional argument, error message will be dropped if not present. This argument is intent(out).
compressed: Shall be a logical expression that determines if the npz file should be compressed. The argument is optional and intent(in). The default value is .false..
{!example/io/example_save_npz.f90!}Experimental
Read a whole line from a formatted unit into a string variable
call [[stdlib_io(module):getline(interface)]] (unit, line[, iostat][, iomsg])
call [[stdlib_io(module):getline(interface)]] (line[, iostat][, iomsg])
unit: Formatted input unit.
This argument is intent(in).
If unit is not specified standard input is used.
line: Deferred length character or string_type variable.
This argument is intent(out).
iostat: Default integer, contains status of reading from unit, zero in case of success.
It is an optional argument, in case not present the program will halt for non-zero status.
This argument is intent(out).
iomsg: Deferred length character value, contains error message in case iostat is non-zero.
It is an optional argument, error message will be dropped if not present.
This argument is intent(out).
{!example/io/example_getline.f90!}Experimental
Formatting constants for printing out integer, floating point, and complex numbers at their full precision.
Provides formats for all kinds as defined in the stdlib_kinds module.
{!example/io/example_fmt_constants.f90!}Experimental
Compresses a file or directory into a zip archive.
call [[stdlib_io_zip(module):zip(subroutine)]] (output_file, files[, stat][, msg][, compressed])
output_file: Character expression representing the name of the zip file to create. This argument is intent(in).
files: Array of string_type representing the names of the files to compress. This argument is intent(in).
stat: Default integer, contains status of reading from unit, zero in case of success. This argument is optional and intent(out).
msg: Deferred length character value, contains error message in case iostat is non-zero. It is an optional argument, error message will be dropped if not present. This argument is intent(out).
compressed: Logical expression that determines if the zip file should be compressed. The argument is optional and intent(in). The default value is .true..
Experimental
Extracts a zip archive into a directory.
call [[stdlib_io_zip(module):unzip(subroutine)]] (filename, outputdir[, stat][, msg])
filename: Character expression representing the name of the zip file to extract. This argument is intent(in).
outputdir: Character expression representing the name of the directory to extract the zip file to. This argument is intent(in).
stat: Default integer, contains status of reading from unit, zero in case of success. This argument is optional and intent(out).
msg: Deferred length character value, contains error message in case iostat is non-zero. It is an optional argument, error message will be dropped if not present. This argument is intent(out).
Experimental
Whether a file or directory exists at the given location in the filesystem.
is_existing = [[stdlib_io_filesystem(module):exists(function)]] (filename)
filename: Character expression representing the name of the file or directory to check for existence. This argument is intent(in).
Experimental
Lists the contents of a directory.
call [[stdlib_io_filesystem(module):list_dir(subroutine)]] (dir, files[, iostat][, iomsg])
dir: Character expression representing the name of the directory to list. This argument is intent(in).
files: Array of string_type representing the names of the files in the directory. This argument is intent(out).
iostat: Default integer, contains status of reading from unit, zero in case of success. This argument is optional and intent(out).
iomsg: Deferred length character value, contains error message in case iostat is non-zero. It is an optional argument, error message will be dropped if not present. This argument is intent(out).
Experimental
Runs a command in the shell.
call [[stdlib_io_filesystem(module):run(subroutine)]] (command[, iostat][, iomsg])
command: Character expression representing the command to run. This argument is intent(in).
iostat: Default integer, contains status of reading from unit, zero in case of success. This argument is optional and intent(out).
iomsg: Deferred length character value, contains error message in case iostat is non-zero. It is an optional argument, error message will be dropped if not present. This argument is intent(out).