Class acol_manager (o2scl_acol)¶

O2scl : Class List

class acol_manager¶

The driver for ‘acol’ command-line utility.

Todo

In class acol_manager:

(Future) There is quite a bit of code duplication in comm_autocorr() between the “table” and “other” types. This could be streamlined.
(Future) sum/max/min/output/interp/deriv/integ/deriv2 for hist, hist_2d, and v<c>
(Future) Commands xindex and yindex for table3d.
(Future) Enable set_grid() for table3d similar to tensor_grid.
(Future) Fix fit for table.
(Future) Use swap instead of copy in ‘select’ for table objects.
(Future) Make sure get_input() is used more consistently.
(Future) Make sure preview, output, internal, generic, and create work consistently across all types.
(Future) Stack-like operations (push, pop, swap, stack-list, etc.)?
(Future) Add functionality to ensure that three digit exponents are still handled gracefully (do this by creating a new boolean setting which, if true, always makes three spaces for exponents?)
(Future) Fix insert and insert_full so that it automatically renames columns
(Future) Allow “insert” commands to be restrictive, avoiding extrapolation

Parameters modifiable by the user

int precision¶: The output precision (default 6)

bool pretty¶: True if we should make the output into neat columns (default true)

bool names_out¶: If true, output names at the top of some objects.

bool use_regex¶: True to use regex (false)

std::string obj_name¶: The name of the table.

std::string def_args¶: Default arguments from environment.

int ncols¶: The number of columns requested by the user (default 0 for autodetect)

int interp_type¶

The interpolation type (default is 1; linear)

The valid interpolation types are 1: linear, 2: cubic, 3: periodic cubic, 4: akima, 5: periodic akima, 6: monotonic [experimental], 7: Steffen’s monotonic, 8: nearest neighbor [experimental].

Note that when this value is modified and the current object is a table, table3d or a histogram object, it also modifies the interpolation type of the object.

int compress¶: If set, try to compress.

bool scientific¶: True for scientific output mode.

The parameter objects

o2scl::cli::parameter_string p_obj_name¶

o2scl::cli::parameter_string p_def_args¶

o2scl::cli::parameter_int p_verbose¶

o2scl::cli::parameter_int p_compress¶

o2scl::cli::parameter_int p_precision¶

o2scl::cli::parameter_int p_ncols¶

o2scl::cli::parameter_int p_interp_type¶

o2scl::cli::parameter_bool p_scientific¶

o2scl::cli::parameter_bool p_pretty¶

o2scl::cli::parameter_bool p_names_out¶

o2scl::cli::parameter_bool p_use_regex¶

int verbose¶: The verbosity level (default 1)

std::string type¶: String designating the current type.

o2scl::cli *cl¶: Dummy cli object for cli::cli_gets()

acol_manager()¶

inline virtual ~acol_manager()¶

Object storage

o2scl::table_units table_obj¶

o2scl::table3d table3d_obj¶

o2scl::hist hist_obj¶

o2scl::hist_2d hist_2d_obj¶

int int_obj¶

char char_obj¶

double double_obj¶

size_t size_t_obj¶

std::string string_obj¶

std::vector<o2scl::contour_line> cont_obj¶

o2scl::uniform_grid<double> ug_obj¶

std::vector<int> intv_obj¶

std::vector<double> doublev_obj¶

std::vector<size_t> size_tv_obj¶

std::vector<std::string> stringv_obj¶

std::vector<std::vector<std::string>> vvstring_obj¶

o2scl::tensor tensor_obj¶

o2scl::tensor<int> tensor_int_obj¶

o2scl::tensor<size_t> tensor_size_t_obj¶

o2scl::tensor_grid tensor_grid_obj¶

o2scl::prob_dens_mdim_amr pdma_obj¶

bool post_interactive¶: True if we should run interactive mode after parsing the command-line.

std::string env_var_name¶: The environment variable to read from.

std::map<std::string, int*> int_params¶: Integer parameters.

void xml_replacements(std::string &s, std::vector<std::string> &clist)¶: Make all of the XML replacements in string s based on the command list clist.

void command_add(std::string new_type)¶: Add new commands for type new_type.

void update_o2_docs(size_t narr, o2scl::comm_option_s *options_arr, std::string new_type = "")¶: Update the command documentation from the o2scl data file.

void command_del(std::string ltype)¶: Remove the type-specific commands.

Note

This needs to be public for the o2graph interface

inline int get_verbose()¶

Get the verbose parameter.

This function is used in o2scl_acol_mult_vectors_to_conts() .

virtual int run(int argv, char *argc[], bool full_process = true)¶

Main run function.

Process command-line options using cli object, interface with the operating system via getenv(), instantiate and call the acol_manager object.

virtual int setup_cli()¶: Create the cli object (with readline support if available)

virtual int setup_options()¶: Add the options to the cli object.

virtual int setup_help()¶: Add the help text to the cli object.

virtual int setup_parameters()¶: Add the parameters for ‘set’ to the cli object.

void clear_obj()¶: Clear memory associated with the current object and set type to “”.

Temporary storage

These are used in o2scl_acol_get_slice(), o2scl_acol_get_hist_reps(), o2scl_acol_get_hist_wgts(), o2scl_acol_get_hist_bins(), and o2scl_acol_get_hist_2d(),

std::vector<double> xtemp¶

std::vector<double> ytemp¶

std::vector<double> stemp¶

std::vector<int> itemp¶

std::vector<char> ctemp¶

int validate_interp_type()¶

Functions for the command-line interface

virtual int comm_assign(std::vector<std::string> &sv, bool itive_com)¶

Assign a constant.

For objects of type table:

Assign a constant to the table, e.g. -assign pi "acos(-1)".

Arguments: <name> val

Assign a constant value to a name for the present table. Valid constant values are things like 1.618, acos(-1.0) or sin(4^5). To remove an assignment, call assign with a blank value.

virtual int comm_ser_hist_t3d(std::vector<std::string> &sv, bool itive_com)¶

Convert a series of histograms to a table3d object.

For objects of type table:

Histogram series in a table3d object.

Arguments: <grid vector spec.> <direction ("x" or "y")> <grid name> <bin edges vector spec.> "<bin grid vector spec.> <bin name> <pattern> <new slice>

Detailed desc.

virtual int comm_binary(std::vector<std::string> &sv, bool itive_com)¶

Binary function for tensors.

For objects of type tensor_grid:

Apply a binary function to two tensor_grid objects.

Arguments: <file> <object name> <function>

Read tensor_grid named <object name> from file <file> and use it along with the function <function> to modify the current tensor_grid object. The <function> parameter should be a mathematical function of the value in the current tensor (v), the value in the tensor named <object name> (w), the indices (i0, i1, …) or the grid points (x0, x1, …).

virtual int comm_average_rows(std::vector<std::string> &sv, bool itive_com)¶

Average rows together.

For objects of type table:

Average rows of some or all columns together.

Arguments: <column or '*' for all> <window> [block averages]

The first argument is the column to be modified. If the first argument is ‘*’, then all columns are averaged. The second argument is the size of the window. If the third argument evaluates to false, then block averages instead of rolling averages are computed, and then the number of rows is divided by the window parameter. If block averages are requested, then the first argument must be ‘*’.

virtual int comm_correl(std::vector<std::string> &sv, bool itive_com)¶

Compute correlation.

For objects of type table:

Compute the correlation coefficient between two columns.

Arguments: <column 1> <column 2>

Compute the correlation coefficient between two columns, or, if no arguments are given, then compute the correlation coefficients between all pairs of columns.

virtual int comm_refine(std::vector<std::string> &sv, bool itive_com)¶

Refine an object.

For objects of type table:

Refine the table.

Arguments: <index column> <factor>

Detailed desc.

virtual int comm_calc(std::vector<std::string> &sv, bool itive_com)¶

Compute the value of a constant expression.

Arguments: <expr> ["1" for adaptive multiprecision]

This computes the value of the constant mathematical expression <expr>. Examples are calc acos(-1) or calc 2+1/sqrt(2.0e4). To see which operators and functions can be used, use ‘acol -help functions’.

Results are given at the current value of precision. Values of precision up to 50 are allowed, and multiprecision (rather than double precision) arithmetic is used if necessary. For example, try acol -set precision 45 -calc "acos(-1)". If the second optional argument evaluates to true, the calc command uses multiprecision to attempt to ensure the result is exact to within the requested precision.

Constant values from the constant library (see ‘acol -help constant’) will automatically be used, so long as they have a unique value in MKS units. However, some constant values are currently only stored to double precision and will be arbitrarily promoted to higher-precision without warning. Unicode is also supported for constants, so try, e.g. acol -set precision 15 -calc π.

Note that the variable precision is used for the argument to the cout.precision() function, so a precision of 10 is actually 11 significant figures. When adaptive multiprecision is enabled, the value is computed to within a relative tolerance of \( 10^{-\mathrm{precision}-1} \).

virtual int comm_clear(std::vector<std::string> &sv, bool itive_com)¶

Clear the current object.

Arguments: (No arguments.)

Deallocate the memory associated with the current object. This command does not clear the object name stored in obj_name.

virtual int comm_help(std::vector<std::string> &sv, bool itive_com)¶

Get help.

Arguments: [command or parameter or type or topic]

If no argument is specified, this outputs all of the commands which are valid for the current type, and then some generic help for using acol. If a command is specified as the argument, then help for that command is printed. If a parameter which is modifiable by the get or set commands is specified as the argument, then the help for that parameter is printed. If a type is specified as the argument, then a list of commands which operate on objects of that type is printed. Finally, if a help topic is specified as the argument, then that help information is printed.

virtual int comm_commands(std::vector<std::string> &sv, bool itive_com)¶

List commands, with an optional type argument.

Arguments: [type]

If no argument is specified, list all valid commands for the current type (including those commands which do not require a current object). If a type argument is given, then list all valid commands for the specified type.

virtual int comm_create(std::vector<std::string> &sv, bool itive_com)¶

Create an object.

Arguments: <type> [...]

Create a new object of type <type>. If an object is currently in memory, it is deallocated before creating the new object.

create <type> <val>: For types char, int, size_t, and string, create an object and give it the initial value specified.

create double <value spec.>: Create a double

object and set it equal to the value specified by <value spec.>. (See “acol -help <tt>functions</tt>’ for help on specifying

functions and “acol -help value-spec” for help on value

specifications.)

<tt>create <type> <size> <function of “i”></tt>: For array

types <tt>int[]</tt> and <tt>size_t[]</tt>, the user must

specify the size of the array and a function of the array

index <tt>i</tt> to fill the array.

<tt>create double[] [<size> <function of “i”>]

or [vector spec.]</tt>: For <tt>double[]</tt> the user must either

give a vector specification, or specify the size of the array

and a function of the array index <tt>i</tt>.

<tt>create table <name> <vector spec.></tt>:

Create a new <tt>table</tt> object with one column named <name>

from a vector specification (see <tt>Vector specifications</tt>

for the syntax).

<tt>create tensor <rank> <size 0> <size 1> …</tt>: Create a

<tt>tensor</tt> object with the specified rank and sizes. All

tensor entries are initialized to zero.

<tt>create tensor_grid <rank> <size 0> <size 1> …</tt>:

Create a <tt>tensor_grid</tt> object with the specified rank

and sizes. The tensor grid is initialized to count each index

(beginning with zero) and the entries of the tensor are

initialized to zero. The grid can be specified afterwards

using <tt>set-grid</tt>.

<tt>create table3d <x name> <x vector spec.> <y name> <y

vector spec.>\n <slice name> <slice function></tt>: Create a

new <tt>table3d</tt> object which has one slice. The x and y

grids are given as vector specifications (see “acol -help vector-spec” for the syntax). The slice function can be

written in terms of the x- and y-grid values which are

referred to by name.

For example, using <tt>o2graph</tt> from o2sclpy:

<tt>o2graph -create table3d x func:100:i/200 y func:100:i/200

z “sin(1/(x+0.01))* sin(1/(y+0.01))” -den-plot z -xtitle x -ytitle y -show

virtual int comm_set_grid(std::vector<std::string> &sv, bool itive_com)¶

Set the grid for a o2scl::tensor_grid object.

For objects of type tensor_grid:

Set the tensor grid.

Arguments: <index> <func. or vector spec>

The first argument for the set-grid command specifies the index for which grid to set. The second argument specifies the grid. If it contains a ‘:’, it is assumed to be a vector specification (see ‘help vector-spec’). Otherwise, the argument is assumed to be a function which specifies the grid value as a function of the variables ‘i’ and ‘x’. The value of ‘i’ ranges from 0 to m-1, where ‘m’ is the tensor size for each rank and the value of ‘x’ is equal to the previous grid value.

virtual int comm_get_grid(std::vector<std::string> &sv, bool itive_com)¶

Get the grid for a o2scl::tensor_grid object.

For objects of type table3d:

Print out the table3d grid.

Arguments: (No arguments.)

Output the table3d grid as a series of columns.

For objects of type tensor_grid:

Get the tensor grid.

Arguments: (No arguments.)

Output the tensor grid as a series of columns.

virtual int comm_download(std::vector<std::string> &sv, bool itive_com)¶

Download a file from the specified URL.

Arguments: <file> <URL> [hash, "file:"hash_filename, or "none"] [directory]

Check if a file matches a specified hash, and if not, attempt to download a fresh copy from the specified URL. If the filename is “_”, then the file is extracted from the end of the URL.

virtual int comm_xml_to_o2(std::vector<std::string> &sv, bool itive_com)¶

Parse doxygen XML to generate runtime docs.

Arguments: (No arguments.)

When pugixml is enabled, this function reads the doxygen XML output and generates an HDF5 file which acol reads to generate the runtime documentation.

virtual int comm_docs(std::vector<std::string> &sv, bool itive_com)¶

Open local HTML docs for O₂scl documentation.

Arguments: [section, class, or function]

If [topic] is unspecified, this command opens up the local HTML documentation for O₂scl in the default web browser using ‘open’ on OSX and ‘xdg-open’ on other systems. If a topic is specified, then the docs command looks for the O₂scl documentation web page for the specified section, class, or function. If the documentation is found, then that web page is opened instead. In order to open the remote version of the documentation instead of the local copy, use the wdocs command instead.

virtual int comm_wdocs(std::vector<std::string> &sv, bool itive_com)¶

Open remote HTML docs for acol or an O₂scl topic.

Arguments: ["dev"] [search_term], [topic] or [section search_term]

If no arguments are given, this command opens up the remote HTML documentation for acol in the default web browser using ‘open’ on OSX and ‘xdg-open’ on other systems. If a [topic] is specified, then the associated O₂scl web page is opened. If the argument does not match an already known topic, then the search feature on the O₂scl web page is opened using the specified search term. Note that, for search terms, spaces can be included using e.g. ‘-wdocs “Simulated annealing”’. Valid sections are either “eos” or “part”. If the optional argument “dev” is given, then the development raterh than release documentation is used. In order to open the local version of the documentation instead of the remote copy, use docs instead of wdocs.

virtual int comm_delete_col(std::vector<std::string> &sv, bool itive_com)¶

Delete a column.

For objects of type table:

Delete a table column.

Arguments: <name>

Delete the entire column named <name>.

virtual int comm_delete_rows(std::vector<std::string> &sv, bool itive_com)¶

Delete rows.

For objects of type table:

Delete rows selected by a function.

Arguments: <function>

Delete the set of rows for which a function evaluates to a number greater than 0.5. For example, -delete-rows if(col1+col2>10,1,0) will delete all columns where the sum of the entries in col1 and col2 is larger than 10. See also the select-rows command.

virtual int comm_delete_rows_tol(std::vector<std::string> &sv, bool itive_com)¶

Delete rows which match to within a specified tolerance.

For objects of type table:

Delete rows which match to within a specified tolerance

Arguments: [relative tol.] [absolute tol.]

This command deletes all rows which match within the specified tolerances. If verbose is larger than zero then information about how many rows were deleted is provided.

virtual int comm_deriv(std::vector<std::string> &sv, bool itive_com)¶

Compute a derivative.

For objects of type table:

Derivative of a function defined by two columns.

Arguments: <x> <y> <name>

Create a new column named <name> filled with the derivative of the function y(x) obtained from columns <x> and <y>.

For objects of type tensor:

Compute the derivative of the tensor object w.r.t. an index

Arguments: <index>

The deriv command differentiates the tensor object with respect to one of the indices.

For objects of type tensor_grid:

Compute the derivative of the tensor object w.r.t. an index

Arguments: <index>

The deriv command differentiates the tensor object with respect to one of the indices.

For objects of type double[]:

Replace the array with its derivative.

Arguments: (No arguments.)

Replace the array with its derivative using the current interpolation type.

For objects of type int[]:

Replace the array with its derivative.

Arguments: (No arguments.)

Replace the array with its derivative using the current interpolation type, converting it to a double[].

For objects of type size_t[]:

Replace the array with its derivative.

Arguments: (No arguments.)

Replace the array with its derivative using the current interpolation type, converting it to a double[].

virtual int comm_to_table(std::vector<std::string> &sv, bool itive_com)¶

Convert object to a o2scl::table object.

For objects of type double[]:

Convert to a table object.

Arguments: <column name>

Convert the vector to a table with a single column named <column name>.

For objects of type int[]:

Convert to a table object.

Arguments: <column name>

Convert the vector to a table with a single column named <column name>.

For objects of type size_t[]:

Convert to a table object.

Arguments: <column name>

Convert the vector to a table with a single column named <column name>.

For objects of type tensor_grid:

Convert to a table object.

Arguments: <index> <grid name> <data name> [values of fixed indices]

Detailed desc.

For objects of type table3d:

Convert to a table object.

Arguments: (No arguments.)

Detailed desc.

For objects of type hist:

Convert to a table object.

Arguments: (No arguments.)

Convert to a table object.

virtual int comm_diag(std::vector<std::string> &sv, bool itive_com)¶

Get entries along the main diagonal.

For objects of type tensor:

Get diagonal elements.

Arguments: (No arguments.)

Extract only the elements on the main diagonal to create a double[] object.

virtual int comm_to_table3d(std::vector<std::string> &sv, bool itive_com)¶

Convert object to a o2scl::table3d object.

For objects of type table:

Convert a table to a table3d object.

Arguments: <x column> <y column> [empty value] [eps]

The ‘to-table3d’ creates a table3d object using ‘x column’ and ‘y column’ as the data for the x and y grids. If ‘empty value’, then this value is used for points not given by the table. If ‘eps’ is specified, then use that value as the minimum value between grid points.

For objects of type tensor:

Select two indices and convert to a table3d object.

Arguments: <x index> <y index> <slice name> [fixed 1] [fixed 2] ...

This command uses two indices in the current tensor object to create a table3d object. The values for the remaining indices fixed to [fixed 1], [fixed 2], etc. in that order. For example, “to-table3d 3 1 z 5 3” uses index 3 for the x coordinate of the new table3d object, uses index 1 for the y coordinate of the new table3d object, uses 5 for index 0, and uses 3 for index 2.”+ The x- and y-grids in he table3d object

are named “x” and “y” and filled with the grid index by

default.”+ To set the x- or y-grid names afterwards, use commands ‘x-name’ and ‘y-name’.

For objects of type tensor<int>:

Select two indices and convert to a table3d object.

Arguments: <x index> <y index> <slice name> [fixed 1] [fixed 2] ...

are named “x” and “y” and filled with the grid index by

default.”+ To set the x- or y-grid names afterwards, use commands ‘x-name’ and ‘y-name’.

For objects of type tensor<size_t>:

Select two indices and convert to a table3d object.

Arguments: <x index> <y index> <slice name> [fixed 1] [fixed 2] ...

are named “x” and “y” and filled with the grid index by

default.”+ To set the x- or y-grid names afterwards, use commands ‘x-name’ and ‘y-name’.

For objects of type tensor_grid:

Select two indices and convert to a table3d object.

Arguments: <x index> <y index> <slice name> [value 1] [value 2] ...

This command uses two indices in the current tensor_grid object to create a table3d object. The values for the remaining indices are by interpolation to [value 1], [value 2], etc. in that order. For example, “to-table3d 3 1 z 0.5

2.0” uses index 3 for the x coordinate of the new table3d object, uses index 1 for the y coordinate of the new table3d object, uses interpolation to set the value of the index 0 to 0.5, and uses interpolation to set the value of index 2 to to 2.0. The x- and y-grids in the table3d object are named “x” and “y” by default. To set the x- or y-grid names afterwards, use commands ‘x-name’ and ‘y-name’.

For objects of type hist_2d:

Convert to a hist_2d object.

Arguments: <x name> <y name> <weight name>

Convert to a hist_2d object using the specified names.

For objects of type prob_dens_mdim_amr:

Select two indices and convert to a table3d object.

Arguments:

<x index> <y index> <x name> <x points> <y


name> <y points> <slice name>

Select two indices and convert to a table3d object.

virtual int comm_to_tensor_grid(std::vector<std::string> &sv, bool itive_com)¶

Convert object to a o2scl::tensor_grid object.

For objects of type table3d:

Convert a slice of the table3d object to a tensor_grid object.

Arguments: <slice>

Detailed desc.

For objects of type tensor:

Convert the tensor to a tensor_grid object.

Arguments: [function 1] [function 2] ...

Convert a tensor to a tensor_grid object, using functions to specify the grid for each index. The functions should be specified as functions of the variable ‘i’, which runs from 0 to size-1 for each index. Any user-specified functions are used up to the rank of the tensor, and if not enough functions are specified, then the function ‘i’ is used.

virtual int comm_to_tg_fermi(std::vector<std::string> &sv, bool itive_com)¶

Convert object to a o2scl::tensor_grid object.

For objects of type table3d:

Convert a slice of the table3d object to a tensor_grid object.

Arguments: <slice>

Detailed desc.

For objects of type tensor:

Convert the tensor to a tensor_grid object.

Arguments: [function 1] [function 2] ...

virtual int comm_to_tensor(std::vector<std::string> &sv, bool itive_com)¶

Convert object to a o2scl::tensor object.

For objects of type tensor_grid:

Convert to a tensor object.

Arguments: (No arguments.)

Convert to a tensor object, ignoring the grid.

virtual int comm_to_table3d_sum(std::vector<std::string> &sv, bool itive_com)¶

Convert object to a o2scl::table3d object by summing over tensor indices.

For objects of type tensor:

Select two indices and convert to a table3d object.

Arguments: <x name> <y name> <slice name> [fixed 1] [fixed 2] ...

Detailed desc.

virtual int comm_autocorr(std::vector<std::string> &sv, bool itive_com)¶

Compute the autocorrelation coefficients.

If there is no current object:

Compute autocorrelation coefficients from a set of vectors

Arguments: <mult. vec. spec. 1> [mult. vec. spec. 2]

This command computes the autocorrelation coefficients for all vectors specified as multiple vector specifications in the arguments, then averages those autocorrelation coefficients together. The averaged autocorrelation coefficients are kept as a new double[] object. See Multiple vector specifications for more information.

For objects of type int[]:

Arguments: (No arguments.)

Replace the current object with a double[] object which contains the autocorrelation coefficient as a function of the step size.

For objects of type double[]:

Arguments: (No arguments.)

Replace the current object with a double[] object which contains the autocorrelation coefficient as a function of the step size.

For objects of type table:

Arguments: <ac> <ftom> <column or vector specification> [second column or vector specification] ...

Compute autocorrelation coefficients from a column of a table. The first argument, <ac>, is the name of the column in which the autocorrelation coefficients will be stored. The second argument, <ftom>, is the name of the column in which the quantity ‘5*tau/M’ will be stored. The data may be either a column in the table or a vector specification. Columns <ac> and <ftom> are created if they are not already present and overwritten if they already contain data. Also, the autocorrelation length and estimated sample size are output to the screen. If multiple data sources are given, then the autocorrelation coefficients are averaged together. See also Vector specifications for more information on the third and fourth arguments.

virtual int comm_ac_len(std::vector<std::string> &sv, bool itive_com)¶

Compute the autocorrelation coefficient using acor.

For objects of type table:

Compute the autocorrelation coefficient using acor

Arguments: <column>

Detailed desc.

virtual int comm_deriv_x(std::vector<std::string> &sv, bool itive_com)¶

Create a slice which is the derivative wrt x of another.

For objects of type table3d:

Derivative with respect to x.

Arguments: <f> <dfdx>

Create a new slice named <dfdx> filled with the derivative of the function from the x grid and slice named <f>.

virtual int comm_deriv_y(std::vector<std::string> &sv, bool itive_com)¶

Create a slice which is the derivative wrt y of another.

For objects of type table3d:

Derivative with respect to y.

Arguments: <f> <dfdy>

Create a new slice named <dfdy> filled with the derivative of the function from the y grid and slice named <f>.

virtual int comm_deriv2(std::vector<std::string> &sv, bool itive_com)¶

Compute a second derivative.

For objects of type table:

Second derivative of a function defined by two columns.

Arguments: <x> <y> <name>

Create a new column named <name> filled with the second derivative of the function y(x) obtained from columns <x> and <y>.

virtual int comm_filelist(std::vector<std::string> &sv, bool itive_com)¶

List objects in a HDF5 file.

Arguments: <file>

This lists all the top-level datasets and groups in a HDF5 file and, for those groups which are in the O₂scl format, gives the type and name of the object stored in that HDF5 group.

virtual int comm_read(std::vector<std::string> &sv, bool itive_com)¶

Read an object from an O₂scl-style HDF5 file.

Arguments: <file> [object name]

Read an HDF5 file with the specified filename. If the [object name] argument is specified, then read the object with the specified name. Otherwise, look for the first table object, and if not found, look for the first table3d object, and so on, attempting to find a readable O₂scl object.

virtual int comm_nlines(std::vector<std::string> &sv, bool itive_com)¶

Add ‘nlines’ as a constant to a o2scl::table object.

For objects of type table:

Add ‘nlines’ as a constant to a table object.

Arguments: (No arguments.)

Add a constant called ‘nlines’ to the table and set it equal to the number of lines (rows) in the table.

virtual int comm_to_hist(std::vector<std::string> &sv, bool itive_com)¶

Convert to a o2scl::hist object.

For objects of type table:

Convert a table to a histogram.

Arguments: <col> <n_bins> [wgts]

The ‘to-hist’ command creates a 1D histogram from ‘col’ using exactly ‘n_bins’ bins and (optionally) weighting the entries by the values in column ‘wgts’. The second form creates a 2D histogram from ‘col1’ and ‘col2’ using N1 bins in the x direction and N2 bins in the y direction, optionally weighting the entries by the column ‘wgts’.

virtual int comm_to_hist_2d(std::vector<std::string> &sv, bool itive_com)¶

Convert to a o2scl::hist_2d object.

For objects of type table:

Convert a table to a 2d histogram.

Arguments: <col x> <col y> <n_x_bins> <n_y_bins> [wgts]

The ‘to-hist-2d’ command creates a 2D histogram from ‘col x’ and ‘col y’ using ‘n_x_bins’ bins in the x direction and ‘n_y_bins’ bins in the y direction, optionally weighting the entries by the column ‘wgts’.

For objects of type table3d:

Convert a table3d slice to a 2d histogram.

<slice>

The ‘to-hist-2d’ command creates a 2D histogram from slice <slice>.

virtual int comm_type(std::vector<std::string> &sv, bool itive_com)¶

Output the type of the current object.

Arguments: (No arguments.)

Show the current object type, either table, table3d, hist, hist_2d, vector<contour_line>, int, double, char, string, int[], double[], string[], size_t, size_t[], uniform_grid<double>, tensor_grid, tensor, tensor<int>, tensor<size_t> or prob_dens_mdim_amr.

virtual int comm_find_row(std::vector<std::string> &sv, bool itive_com)¶

Find a row.

For objects of type table:

Find a row which maximizes a function.

Arguments: <func> or find-row <col> <val>

If one argument is given, then find-row finds the row which maximizes the value of the expression given in <func>, and then output the entire row. Otherwise find-row finds the row for which the value in column named <col> is as close as possible to the value <val>. See command ‘get-row’ to get a row by it’s index.

virtual int comm_function(std::vector<std::string> &sv, bool itive_com)¶

Create a column from a function.

For objects of type table:

Create a column from a function

Arguments: <func> <name>

Set the column named <name> to the result of a function, <func>, in terms of the other columns. If the column does not already exist, a new one is added to the table. For example, for a table containing columns named ‘c1’ and ‘c2’, ‘function c1-c2 c3’ would create a new column c3 which contains the difference of columns ‘c1’ and ‘c2’.

For objects of type double[]:

Set the values of the array given a function.

Arguments: <function>

Set the values of the array given a user-specified function of ‘i’. For example, “(sin(i)>1)*4”.

For objects of type int[]:

Set the values of the array given a function.

Arguments: <function>

Set the values of the array given a user-specified function of ‘i’. For example, “(sin(i)>1)*4”.

For objects of type size_t[]:

Set the values of the array given a function.

Arguments: <function>

Set the values of the array given a user-specified function of ‘i’. For example, “(sin(i)>1)*4”.

For objects of type hist:

Apply a function to the weights.

Arguments: <function>

Apply a function to the weights.

For objects of type table3d:

Create a new slice from a function.

Arguments: <func> <name>

Set the slice named <name> to the result of a function, <func>, in terms of the other slices. If the slice does not already exist, a new one is created. For example, for a table3d containing slices named ‘s1’ and ‘s2’, ‘function s1-s2 s3’ would create a new column ‘s3’ which contains the difference of columns ‘s1’ and ‘s2’.

For objects of type tensor:

Set the tensor values from a function.

Arguments: [cond. function] <function of v, i0, i1, ...>

The function command sets all entries in a tensor equal to a user-specified mathematical function of the indices. When the conditional function evaluates to a number less than or equal to 0.5, then the tensor entry will be unchanged. (For more help with functions, type acol -help functions)

For objects of type tensor_grid:

Set the tensor values from a function.

Arguments: [conditional func.] <func. of v, i0, i1, ... and x0, x1, ...>

The “function” command sets all the data entries in a tensor_grid equal to a user-specified mathematical function of the value in the tensor (v), the indices (i0, i1, …) or the grid points (x0, x1, …). If two function arguments are given and if the first function argument is not “none”, then the first function specifies which tensor entries are to be modified. When the conditional function evaluates to a number less than or equal to 0.5, then the tensor entry will be “

unchanged. (For more help with functions, type “acol -help functions.”.)

virtual int comm_add_vec(std::vector<std::string> &sv, bool itive_com)¶

Add a vector_specification.

For objects of type table:

Add column from a vector specification to the table.

Arguments: <vec. spec.> <column>

Detailed spec.

virtual int comm_generic(std::vector<std::string> &sv, bool itive_com)¶

Read an object generic text file.

Arguments: <type> <file>

Read an object of type <type> from a text file named <file>. The allowed text file formats depend on the particular type specified.

For int, char, double, or size_t objects, the file is assumed to begin with the desired object and it is read using operator>>().

For string objects, the first line is read using std::getline().

For array objects, it is assumed that all array entries are on the first line of the file and no carriage returns are present between entries.

For table objects, the first line of the file must either contain numeric data or column names separated by white space, without carriage returns, except for the one at the end of the line. If the first line contains column names, the second line may optionally contain unit expressions for each column, enclosed by square brackets. All remaining lines are assumed to contain data with the same number of columns as the first line.

For table3d objects, the data must be stored in columns with the first column specifying the x-axis grid point and the second column specifying the y-axis grid point. The remaining columns give the data for each slice at that point. Each grid point must correspond to a row in the file, but the lines need not be in any particular order. The columns may have one header line at top which specifies the names of the x- and y-grids and the names of each slice (in order).

virtual int comm_get_row(std::vector<std::string> &sv, bool itive_com)¶

Print out an entire row.

For objects of type table:

Get a row by index.

Arguments: <index>

Get a row by index. The first row has index 0, and the last row has index n-1, where n is the total number of rows as returned by the ‘list’ command. The ‘index’ command creates a column of row indexes. To find a row which contains a particular value or maximizes a specified function, use ‘find-row’.

virtual int comm_slice(std::vector<std::string> &sv, bool itive_com)¶

Extract a slice from a table3d object to generate a o2scl::table object.

For objects of type table3d:

Convert a slice to a table object.

Arguments: <"x" or "y"> <val>

Extract a slice of a table3d object at fixed x or fixed y to create a new table object. This function uses interpolation with the current interpolation type to interpolate all of the slices in the table3d object to create a table with a column for each slice.

For objects of type tensor_grid:

Slice to a smaller rank tensor_grid object.

Arguments: <index 1> <value 1> <index 2> <value 2> ...

Detailed desc.

virtual int comm_slice_hist(std::vector<std::string> &sv, bool itive_com)¶

Convert a slice to a histogram.

For objects of type table3d:

Construct a histogram from a slice.

Arguments: <slice>

Detailed desc.

virtual int comm_fit(std::vector<std::string> &sv, bool itive_com)¶

Fit data to a function.

For objects of type table:

Fit two columns to a function (experimental).

Arguments: <x> <y> <yerr> <ynew> <par names> <func> <vals>

Detailed desc.

virtual int comm_insert(std::vector<std::string> &sv, bool itive_com)¶

Insert a column from an external table using interpolation.

For objects of type table:

Interpolate a column from another file.

Arguments: <file> <oldy> <newx> [newy]

Insert a column from file <fname> interpolating it into the current table. The column <oldy> is the columns in the file which is to be inserted into the table, using the column <oldx> in the file and <newx> in the table. The new column in the table is named <oldy>, or it is named [newy] if the additional argument is given.

For objects of type table3d:

Interpolate a slice from another file.

Arguments: <file> [new]

virtual int comm_insert_full(std::vector<std::string> &sv, bool itive_com)¶

Insert an external table using interpolation.

For objects of type table:

Insert a table from another file.

Arguments: <fname> [table name] [old_x new_x]

Insert all columns from file <fname> into the current table. The first table is used or the table object named table_name, if specified. If index columns old_x and new_x are not specified, then the insert requires both the current and the source table to have the same number of rows. If they are specified, then interpolation using those index columns is used. If columns in the new table are not present in the current table, then they are added automatically. If a column in the current table has the same name as one in the new table then it is rewritten with new data, with one exception. If a column in the new table has the same name as old_x, then it is left unmodified.

virtual int comm_integ(std::vector<std::string> &sv, bool itive_com)¶

Create a column which is the integral of another.

For objects of type table:

Integrate a function specified by two columns.

Arguments: <x> <y> <name>

Create a new column named <name> filled with the integral of the function y(x) obtained from columns <x> and <y>.

virtual int comm_ninteg(std::vector<std::string> &sv, bool itive_com)¶

Numerically integrate a user-specified function.

Arguments: <function> <variable> <lower limit> <upper limit> ["1" for multiprecision]

This command numerically integrates <function> with respect to <variable> from <lower limit> to <upper limit>. If the fifth argument is either "1" or "true", then multiprecision is used to attempt to ensure the result is accurate to within the requested precision.

At the moment, infinite upper or lower limits are not supported.

Note that the variable “precision” is used for the argument to the cout.precision() function, so precision of 10 is actually 11 significant figures. Thus in multiprecision mode, the integral is computed to within a relative tolerance of \( 10^{-11} \).

An example demonstrating a dilogarithm ladder:

acol -set verbose 2 -set precision 30 \ -calc “pi^2/10-(log((sqrt(5)-1)/2)^2)” 1

Result (cpp_dec_float_35): 7.553956195317414693865200287561e-01

The calc command begins by obtaining the value of pi to 35 digits. It then starts with 35-digit precision and then compares that result to that obtained with 50-digit precision and finds that those two are equal to within the requested precision.

acol -set verbose 2 -set precision 30 \ -ninteg “(-log(1-t)/t)” t 0 “(sqrt(5)-1)/2” 1

Result (cpp_dec_float_35): 7.553956195317414693865200287561e-01

The ninteg command computes this same value using numerical integration (and obtains the same result), using 42-digit -precision internally to evaluate the integrand.

virtual int comm_interactive(std::vector<std::string> &sv, bool itive_com)¶

Toggle interactive mode.

Arguments: (No arguments.)

If given as a command-line parameter, ‘interactive’ toggles the execution of the interactive mode after the command-line parameters are processed. If zero arguments are given to ‘acol’ on the command-line then the interactive interface is automatically turned on.

virtual int comm_internal(std::vector<std::string> &sv, bool itive_com)¶

Output current object in the internal HDF5 format.

Arguments: <file>

Output the current object to the specified file in the internal HDF5 format.

virtual int comm_interp(std::vector<std::string> &sv, bool itive_com)¶

Perform an interpolation using the current object.

For objects of type table:

Interpolate a number into a column.

Arguments: <x name> <x value> <y name>

Interpolate <x value> from column named <x name> into column named <y name>.

For objects of type double[]:

Interpolate an index into the array

Arguments: <x value>

Interpolate <x value> in the array.

For objects of type int[]:

Interpolate an index into the array

Arguments: <x value>

Interpolate <x value> in the array and print out the result as a double.

For objects of type size_t[]:

Interpolate an index into the array

Arguments: <x value>

Interpolate <x value> in the array and print out the result as a double.

For objects of type table3d:

Interpolate x and y values into a slice.

Arguments: <z name> <x value> <y value>

Interpolate (<x value>,<y value>) into the slice named <z

name>.

For objects of type tensor_grid:

Linearly interpolate in the grid.

Arguments: <value 1> <value 2> <value 3> ...

The command “interp” uses linear interpolation to interpolate an array with size equal to the tensor rank into the tensor grid and outputs the result.

virtual int comm_list(std::vector<std::string> &sv, bool itive_com)¶

List properties of an object.

For objects of type table:

List the constants, column names and other info.

Arguments: (No arguments.)

List the constants, column names and other info.

For objects of type table3d:

List the slice names and print out grid info.

Arguments: (No arguments.)

List the slice names and print out grid info.

For objects of type tensor:

List the tensor rank and index sizes.

Arguments: (No arguments.)

List the tensor rank and index sizes.

For objects of type tensor<int>:

List the tensor rank and index sizes.

Arguments: (No arguments.)

List the tensor rank and index sizes.

For objects of type tensor<size_t>:

List the tensor rank and index sizes.

Arguments: (No arguments.)

List the tensor rank and index sizes.

For objects of type tensor_grid:

List the tensor rank and index sizes.

Arguments: (No arguments.)

List the tensor rank and index sizes.

For objects of type hist_2d:

List the bin edges.

Arguments: (No arguments.)

For objects of type hist_2d:

virtual int comm_max(std::vector<std::string> &sv, bool itive_com)¶

Compute the maximum value of a column.

For objects of type table:

Compute the maximum value of a column.

Arguments: <column name>

Compute the maximum value of a column.

For objects of type double[]:

Compute the maximum value and the associated index.

Arguments: (No arguments.)

Compute the maximum value and the associated index.

For objects of type int[]:

Compute the maximum value and the associated index.

(No arguments.)

Compute the maximum value and the associated index.

For objects of type size_t[]:

Compute the maximum value and the associated index.

(No arguments.)

Compute the maximum value and the associated index.

For objects of type table3d:

Compute the maximum value of a slice.

Arguments: <slice name>

Compute the maximum value of a slice.

For objects of type tensor:

Compute the maximum value and the associated index.

(No arguments.)

Compute the maximum value and the associated index.

For objects of type tensor<int>:

Compute the maximum value and the associated index.

(No arguments.)

Compute the maximum value and the associated index.

For objects of type tensor<size_t>:

Compute the maximum value and the associated index.

(No arguments.)

Compute the maximum value and the associated index.

For objects of type tensor_grid:

Compute the maximum value and the associated index and grid point.

(No arguments.)

Compute the maximum value and the associated index and grid point.

For objects of type hist_2d:

Find the maximum weight.

(No arguments.)

Find the maximum weight and print out the location.

virtual int comm_min(std::vector<std::string> &sv, bool itive_com)¶

Compute the minimum value of a column.

For objects of type table:

Compute the minimum value of a column.

Arguments: <column name>

Compute the minimum value of a column.

For objects of type double[]:

Compute the maximum value and the associated index.

(No arguments.)

Compute the maximum value and the associated index.

For objects of type int[]:

Compute the maximum value and the associated index.

(No arguments.)

Compute the maximum value and the associated index.

For objects of type size_t[]:

Compute the maximum value and the associated index.

(No arguments.)

Compute the maximum value and the associated index.

For objects of type table3d:

Compute the minimum value of a slice.

Arguments: <slice name>

Compute the minimum value of a slice.

For objects of type tensor:

Compute the minimum value and the associated index.

(No arguments.)

Compute the minimum value and the associated index.

For objects of type tensor<int>:

Compute the minimum value and the associated index.

(No arguments.)

Compute the minimum value and the associated index.

For objects of type tensor<size_t>:

Compute the minimum value and the associated index.

(No arguments.)

Compute the minimum value and the associated index.

For objects of type tensor_grid:

Compute the minimum value and the associated index and grid point.

(No arguments.)

Compute the minimum value and the associated index and grid point.

For objects of type hist_2d:

Find the minimum weight.

(No arguments.)

Find the minimum weight and print out the location.

virtual int comm_x_name(std::vector<std::string> &sv, bool itive_com)¶

Set the name of the x grid.

For objects of type table3d:

Get or set the name of the x grid.

Arguments: [name]

Get or set the name of the x grid.

virtual int comm_y_name(std::vector<std::string> &sv, bool itive_com)¶

Set the name of the y grid.

For objects of type table3d:

Get or set the name of the y grid.

Arguments: [name]

Get or set the name of the y grid.

virtual int comm_index(std::vector<std::string> &sv, bool itive_com)¶

Add a column for line numbers.

For objects of type table:

Add a column containing the row numbers.

Arguments: [column name]

Define a new column named [column name] and fill the column with the row indexes, beginning with zero. If no argument is given, the new column is named ‘N’.

virtual int comm_output(std::vector<std::string> &sv, bool itive_com)¶

Output the current object to screen or text file.

Arguments: [file]

Output the object to the screen, or if the [file] argument is specified, to a file. This is the same format as can be read using the ‘generic’ command.

virtual int comm_rearrange(std::vector<std::string> &sv, bool itive_com)¶

Rearrange a tensor.

For objects of type tensor:

Rearrange the tensor

Arguments: <index spec. 1> [index spec. 2] ...

Index specifications are: index(ix), fixed(ix), sum(ix), trace(ix1,ix2), reverse(ix), and range(ix,start,end). Index specifications may be specified as separate arguments e.g. “index(1)” “fixed(2,10)” or multiple index specifications may be given in a single argument separated by spaces or commas, e.g. “index(1) fixed(2,10)” or “index(1),fixed(2,10)”. See ‘-help index-spec for more information on the tensor index specifications.

For objects of type tensor<int>:

Rearrange the tensor.

Arguments: <index spec. 1> [index spec. 2] ...

For objects of type tensor<size_t>:

Rearrange the tensor.

Arguments: <index spec. 1> [index spec. 2] ...

For objects of type tensor_grid:

Rearrange the tensor_grid object.

Arguments: <index spec. 1> [index spec. 2] ...

Index specifications are: index(ix), fixed(ix), sum(ix), trace(ix1,ix2), reverse(ix), range(ix,start,end), interp(ix,value), grid(ix,begin,end,n_bins,log), and gridw(ix,begin,end,bin_width,log). Index specifications may be specified as separate arguments e.g. “index(1)” “fixed(2,10)” or multiple index specifications may be given in a single argument separated by spaces or commas, e.g. “index(1)

fixed(2,10)” or “index(1),fixed(2,10)”. See ‘-help index-spec’ for more information on the tensor index specifications.

virtual int comm_preview(std::vector<std::string> &sv, bool itive_com)¶

Preview the current object.

Arguments: [number of lines] [number of columns]

Print out all or part of the current object in format suitable for the screen.

virtual int comm_slack(std::vector<std::string> &sv, bool itive_com)¶

Send a slack message.

Arguments: ["#channel"] <strings-spec>

Send a message to slack, using the specified channel. If the channel is not specified, it is taken from the environment variable O2SCL_SLACK_CHANNEL. The ‘#’ sign should be included with the channel name. The Slack webhook URL is taken from the environment variable O2SCL_SLACK_URL and the username is taken from the environment variable O2SCL_SLACK_USERNAME. The message is constructed from the string list specification in <strings-spec> (see ‘acol -help strings-spec’ for more information).

virtual int comm_value(std::vector<std::string> &sv, bool itive_com)¶

Get or set the value of an object.

For objects of type int:

Arguments: [value]

Get or set the integer.

For objects of type size_t:

Arguments: [value]

Get or set the size_t object.

For objects of type string:

Arguments: [value]

Get or set the string.

For objects of type double:

Arguments: [value spec.]

Get or set the value of the double object. See Value specifications for more information.

For objects of type char:

Arguments: [value]

Get or set the character.

virtual int comm_cat(std::vector<std::string> &sv, bool itive_com)¶

Concatenate two objects.

For objects of type table:

Concatenate a second table object onto current table.

<file> [name]

Add a second table to the end of the first, creating new columns if necessary.

For objects of type table3d:

Concatenate data from a second table3d onto current table3d.

Arguments: <file> [name]

Add all slices from the second table3d object which aren’t already present in the current table3d object.

virtual int comm_sum(std::vector<std::string> &sv, bool itive_com)¶

Sum two objects.

For objects of type table:

Add data from a second table object to current table.

Arguments: <file> [name]

Add all columns from the second table to their corresponding columns in the current table, creating new columns if necessary.

For objects of type double[]:

Compute the vector sum.

(No arguments.)

Compute the vector sum.

For objects of type int[]:

Compute the vector sum.

(No arguments.)

Compute the vector sum.

For objects of type size_t[]:

Compute the vector sum.

(No arguments.)

Compute the vector sum.

For objects of type table3d:

Add data from a second table3d object to current table3d.

Arguments: <file> [name]

Add all slides from the second table3d to their corresponding slices in the current table3d, creating new slices if necessary.

For objects of type tensor:

Output the sum of all the tensor entries.

(No arguments.)

The “sum” command outputs the total tensor size and the sum over all entries. Note, to perform a partial sum over sum of the tensor indices, use the rearrange command.

For objects of type tensor_grid:

Output the sum of all the tensor entries.

(No arguments.)

The “sum” command outputs the total tensor size and the sum over all entries. Note, to perform a partial sum over sum of the tensor indices, use the rearrange command.

virtual int comm_rename(std::vector<std::string> &sv, bool itive_com)¶

Rename a part of an object.

For objects of type table:

Rename a column.

Arguments: <old> <new>

Rename a column from <old> to <new>. Note that to rename the entire object, you should use -set obj_name new_name.

For objects of type table3d:

Rename a slice.

Arguments: <old> <new>

Rename a slice from <old> to <new>. Note that to rename the entire object, you should use -set obj_name new_name.

virtual int comm_select(std::vector<std::string> &sv, bool itive_com)¶

Select part of an object.

For objects of type table:

Select columns for a new table.

Arguments: <column 1> [column 2] ...

Select creates a new table from the present table, including only the columns specified in <cols>. The column specification is a list of column names, functions, or patterns which match the column names. Patterns must be preceeded by a colon ‘:’ and use ECMAScript regular expressions. All of the rows of data are copied over. If functions are specified, the result can be named using ‘=’.

For objects of type table3d:

Select columns for a new table3d.

Arguments: <slice 1> [slice 2] ...

Select creates a new table3d from the present table3d, including only the slices specified in <slice spec.>. The slice specification is a list of slice names, functions, or patterns which match the slice names. Patterns must be preceeded by a colon ‘:’ and can use wildcards like ‘*’ and ‘?’. All of the rows of data are copied over. If functions are specified, the result can be named using ‘=’.

virtual int comm_select_rows(std::vector<std::string> &sv, bool itive_com)¶

Select rows from an object.

For objects of type table:

Arguments: <row specification>

Select the rows from a table for which the row specification in <row_spec> evaluates to a number greater than 0.5.

virtual int comm_set(std::vector<std::string> &sv, bool itive_com)¶: Post-processing for setting a value.

virtual int comm_set_data(std::vector<std::string> &sv, bool itive_com)¶

Set an individual data point at a specified row and column.

For objects of type table:

Set the entries of a column.

Arguments: <row_spec> <col> <val_spec>

Set the value of rows specifed by the ‘row_spec’ function in column ‘col’ to the value given by the ‘val_spec’ function. Rows are chosen if row_spec evaluates to a number greater than 0.5.

For objects of type table3d:

Set the entries of a slice.

Arguments: <x value> <y value> <z name> <val>

Set the value of the slice named ‘z name’ at the grid point closest to (<x value>,<y value>) to the value <val>.

virtual int comm_set_unit(std::vector<std::string> &sv, bool itive_com)¶

Set units of a column.

For objects of type table:

Set the units for a specified column.

Arguments: <column> <unit>

Detailed desc.

virtual int comm_contours(std::vector<std::string> &sv, bool itive_com)¶

Compute contour lines.

For objects of type table3d:

Create contour lines from a table3d slice.

Arguments: <val> <slice_name> [output_filename object_name]

The “contours” command constructs a set of contour lines using the data in slice named <slice> at the fixed value given in <val>. If two additional arguments are given, then the contour lines are stored in the file named output_filename and the object is named object_name. If the file does not exist, it is created. If no contours are found, then no file I/O is performed and the current table3d object is unmodified.

For objects of type hist_2d:

Create contour lines from a table3d slice.

Arguments: ["frac"] <val> [output file] [output name]

If the argument “frac” is not present, the “contours” command constructs a set of contour lines using at the fixed value given in <val>. If two additional arguments are given, then the contour lines are stored in the file named output_filename and the object is named object_name. If the file does not exist, it is created. If no contours are found, then no file I/O is performed and the current table3d object is unmodified.”+ If the argument “frac” is present, then the operation is the same except that <val> is interpreted as a fraction of the total integral under the data.

virtual int comm_get_unit(std::vector<std::string> &sv, bool itive_com)¶

Get units of a column.

For objects of type table:

Get the units for a specified column.

Arguments: <column>

Obtains the units for the specified column.

virtual int comm_entry(std::vector<std::string> &sv, bool itive_com)¶

Get or set an entry.

For objects of type table:

Get or set a single entry in a table.

Arguments: <column> <row> [value or "none"]

This command gets or sets the value in the specified column and row. If “none” is specified as the third argument, then “entry” just prints out the specified entry as if the third argument was not specified.

For objects of type table3d:

Get or set a single entry in a table3d object.

Arguments: <slice> <x index> <y index> [value or "none"]

Detailed desc.

For objects of type tensor:

Get or set a single entry in a tensor object.

Arguments: <index 1> <index 2> <index 3> ... [value or "none"]

Detailed desc.

For objects of type tensor_grid:

Get or set a single entry in a tensor_grid object.

Arguments: <index 1> <index 2> <index 3> ... [value or "none"]

The “entry” command gets or sets a value in the tensor_grid object. The arguments are a list of indices and (optionally) a new value to store in that location.

virtual int comm_entry_grid(std::vector<std::string> &sv, bool itive_com)¶

Get an entry by grid point.

For objects of type table:

Get or set a single entry in a table.

Arguments: <index column> <index value> <target column> [value or "none"]

The “entry-grid” command first looks for the value closest to <index value> in the column <index column> to determine a row in the table. Next “entry-grid” gets or sets the value of the target column in that row. If “none” is specified as the fourth argument, then “entry” just prints out the specified entry as if the third argument was not specified.

For objects of type table3d:

Get a single entry in a table3d object.

Arguments: <slice> <x value> <y value> [value or "none"]

Detailed desc.

For objects of type tensor_grid:

Get a single entry in a tensor_grid object.

Arguments: <value 1> <value 2> <value 3> ... [value or "none"]

The “entry-grid” command gets or sets a value in the tensor_grid object. The arguments are a list of grid values and (optionally) a new value to store in the location closest to the specified grid values.

virtual int comm_convert_unit(std::vector<std::string> &sv, bool itive_com)¶

Convert units.

For objects of type table:

Convert a column to a new unit.

Arguments: <column> <new_unit>

Convert the units of a column to <new unit>, multipliying all entries in that column by the appropriate factor.

virtual int comm_sort(std::vector<std::string> &sv, bool itive_com)¶

Sort data.

For objects of type int[]:

Sort the vector.

(No arguments.)

Sort the vector (in-place).

For objects of type size_t[]:

Sort the vector.

(No arguments.)

Sort the vector (in-place).

For objects of type double[]:

Sort the vector.

(No arguments.)

Sort the vector (in-place).

For objects of type table:

Sort the entire table by one column.

Arguments: <col> [unique]

Sorts the entire table by the column specified in <col>. If the word “unique” is specified as the second argument, then delete duplicate rows after sorting.

virtual int comm_stats(std::vector<std::string> &sv, bool itive_com)¶

Get object statistics.

For objects of type table:

Show column statistics.

Arguments: <column>

Output the average, std. dev, max and min of <column>.

For objects of type table3d:

Show slice statistics.

Arguments: <slice>

Output the average, std. dev, max and min of <slice>.

For objects of type tensor:

Show tensor statistics.

(No arguments.)

The ‘stats’ command outputs the number of entries, their mean, standard deviation, minimum and maximum. It also counts the number of infinite or NaN values.

For objects of type tensor_grid:

Show tensor statistics.

(No arguments.)

The ‘stats’ command outputs the number of entries, their mean, standard deviation, minimum and maximum. It also counts the number of infinite or NaN values.

virtual int comm_wstats(std::vector<std::string> &sv, bool itive_com)¶

Get weighted statistics.

For objects of type table:

Show weighted column statistics.

Output the average, std. dev, max and min of <column>, using the weights specified in <weights>.

For objects of type tensor:

Show stats for the data in the tensor.

(No arguments.)

The ‘stats’ command outputs the number of entries, their mean, standard deviation, minimum and maximum. It also counts the number of infinite or NaN values.

virtual int comm_version(std::vector<std::string> &sv, bool itive_com)¶: Print version information and O₂scl settings.

virtual int comm_convert(std::vector<std::string> &sv, bool itive_com)¶

Manipulate or use a unit conversion factor.

<old unit (or “list”, “add”, “del”, or “nat”)> <new unit> [value to convert]

The convert command handles unit conversions. To compute a unit conversion factor and then optionally apply than conversion factor to a user-specified value. use the form 'acol -convert <old unit> <new unit> [value]'. Conversions which presume ħ=c=kB=1 are allowed by default. For example, 'acol -convert MeV 1/fm' returns ‘1.000000e+00 MeV = 5.067731e-03 1/fm’. The conversion factor is output at the current value of precision, but is always internally stored with full double precision.

If no value to convert is specified, then a value of 1.0 is assumed.

Conversions are cached, so that if the user requests an identical conversion with a different numerical value, then obtaining the conversion from the cache is faster than looking it up and processing it each time.

The convert command attempts to handle arbitrary combinations of powers of SI base units to automatically compute new unit conversion. For example, 'acol -convert "fm^10/g^30" "m^10/kg^30"' reports 1.000000e+00 fm^10/g^30 = 1.000000e-60 m^10/kg^30.

Unit conversions containing constants stored in the constant library are also allowed. For example, 'acol -convert "Msun^2" "g^2"' gives 1.000000e+00 Msun^2 = 3.953774e+66 g^2. SI units are also understood, and both μ and “mu” are interpreted as the “micro” prefix. For example, 'acol -convert "μm" "pc"' or 'acol -convert "mum" "pc"' both report the conversion between micrometers and parsecs.

To print the list of known units, SI prefixes, and the unit conversion cache, use 'acol -convert list'.

To add a unit (only MKS is supported) the format is:

-convert add <unit> <power of meters> <power of kg> <power of seconds> <power of Kelvin> <power of amps> <power of moles> <power of candelas> <val> <long name>

To delete a unit, the format is:

-convert del <unit>

However, note that deleting a unit does not delete its occurences in the unit conversion cache.

While ħ=c=kB=1 is assumed by default, the user can disable conversions taking advantage of these assignments. To modify the use of natural units, use:

-convert nat <boolean for c=1>> <boolean for ħ=1>> <boolean for kB=1>>

virtual int comm_h5_copy(std::vector<std::string> &sv, bool itive_com)¶

Copy an O₂scl-generated HDF5 file.

Copy all O₂scl objects from one HDF5 file to another. This may not work for HDF5 files generated outside of O₂scl. The source and destination filenames may not be identical. The destination file may not be the same size as the source, but will contain the same information.

virtual int comm_constant(std::vector<std::string> &sv, bool itive_com)¶

Get or modify a physical or numerical constant.

<name, pattern, “add”, “del”, “list”, “list-full”> [unit]

If the constant has no units, like the Euler-Mascheroni constant, then e.g. acol -constant euler will report the value 5.772157e-1 (at the default precision which is 6). If the user requests a precision larger than 15 (double precision), then the constant command fails and prints an error message.

If the constant has units but no units are specified as arguments to the constant command, then all values of the constant in the library are written to the screen. If a unit is specified, then the constant command tries to find the unique value with the specified unit. The user can specify, mks, cgs, or the exact unit string of the constant. For example, 'acol -constant hbar cgs' and 'acol -constant hbar g*cm^2/s' both work and return the same value.

Note that some constants in the library are not known to full double precision and acol currently has no way of reporting this.

Search patterns are also allowed, for example 'acol -constant "satur*"' returns all the constants related to saturn in both MKS and CGS units. If use_regex is set to true, then regex is used to do the pattern matching, and otherwise fnmatch() is used. Unicode is allowed, but pattern matching and unicode is not fully functional.

To list all the constants in the library, use 'acol -constant list'. Alternatively, acol -constant list-full gives all information for all constants, including all aliases, the source, and all the decompositions into base units.

One can delete a constant with, e.g. 'acol -del pi' (this doesn’t quite work yet for constants with different values in different unit systems).

To add a constant, one must specify the name of the constant, the value, the unit system, the unit flag, the source, and then the 7 powers of the SI base units (in order m,kg,s,K,A,mol,cd).

int get_input(std::vector<std::string> &sv, std::vector<std::string> &directions, std::vector<std::string> &in, std::string comm_name, bool itive_com)¶: An internal command for prompting the user for command arguments.

int get_input_one(std::vector<std::string> &sv, std::string directions, std::string &in, std::string comm_name, bool itive_com)¶: An internal command for prompting the user for one command argument.

Protected Types

typedef boost::multiprecision::number<boost::multiprecision::cpp_dec_float<100>> cpp_dec_float_100¶

typedef boost::multiprecision::number<boost::multiprecision::cpp_dec_float<50>> cpp_dec_float_50¶

typedef boost::multiprecision::number<boost::multiprecision::cpp_dec_float<35>> cpp_dec_float_35¶

typedef boost::multiprecision::number<boost::multiprecision::cpp_dec_float<25>> cpp_dec_float_25¶

Protected Attributes

o2scl::rng rng¶: Random number generator.

o2scl::rng<long double> rng_ld¶

o2scl::slack_messenger smess¶: The object which sends Slack messages.

std::map<std::string, std::vector<std::string>> type_comm_list¶: A list of all type-specific commands for each type.

std::vector<std::string> type_list¶: A list of all types.

bool o2graph_mode¶: If true, then run in o2graph mode.

o2scl::comm_option_mfptr<acol_manager> cset¶: The object for the set function.

o2scl::format_float ffl¶: The number formatter for html output.

std::vector<std::vector<std::string>> cmd_doc_strings¶: Document strings for commands.

std::vector<std::vector<std::string>> param_doc_strings¶: Document strings for parameters.

std::vector<std::vector<std::string>> help_doc_strings¶: Document strings for help topics.

o2scl::convert_units<double> &cng¶: Convert units object (initialized by constructor to global object)