Array Parser and Formatter

coordinate_parse is the default array parser in the old suite, given the generic usage of this tool, the name is confusing. It will be replaced by parse_array routine in the new version of the code, some of it’s features, for example returning a list of tuples will be seperated into routines that specialize in given tasks. Moreover, the limitted feature it contains does not justify it being a class, a routine would do the job just as well.

In the meantime, the coordinate focused algorithm design will shift to a more generic algorithm, and the coordinate focues features will move to specialized routines. If necessary, the notion of a Coordinate class can be re-introduced (Not as “super-tuple” though, the class will be focused only on representing coordinate).

table_text class is also going to be replaced by a callable formatter class, meaning the class will be instantiated with a specific set of configurations on how to format the data, and the __call__ method of the class will take in the data and return the formatted string. Some presets can be provided to quick calls, but the class will provide ultimate flexibility which justfies itself being a class instead of a routine.

coord_to_string routine provides quick formatting of arrays, tuples and coordinates, but it still requires some level of generalization so it can represent different data types more accurately.

The basic usages of these parser and formatter will remains similar.

import numpy as np
from fractions import Fraction
from coordinate_tools import coord_to_string as c2s, coordinate_parse, table_text

Examples:

coord = coordinate_parse("0 0 0; 1/2 0 0; 1/3 2/3 0", Fraction)

coord.get_coord() # returns the first coordinate of the list, for backward compatibility

(Fraction(0, 1), Fraction(0, 1), Fraction(0, 1))

coord.get_coord_list() # gets the whold list of coordinates

[(Fraction(0, 1), Fraction(0, 1), Fraction(0, 1)),
 (Fraction(1, 2), Fraction(0, 1), Fraction(0, 1)),
 (Fraction(1, 3), Fraction(2, 3), Fraction(0, 1))]

coord_to_string converts a coordinate to a formated string to be more readable:

map(c2s, coord.get_coord_list())

['(0, 0, 0)', '(1/2, 0, 0)', '(1/3, 2/3, 0)']

table_text format array into a table (1d or 2d array):

print table_text(coord.get_coord_list())

     0   0 0
   1/2   0 0
   1/3 2/3 0

Let’s say if you want to print a table to insert in a LaTeX document:

print table_text(coord.get_coord_list(),
                 cdelim=" & ",
                 rdelim=" \\\\\n",
                 lmargin="\left[ ",
                 rmargin=r" \right] ",
                 center="r",
                )

\left[   0 &   0 & 0 \right]  \\
\left[ 1/2 &   0 & 0 \right]  \\
\left[ 1/3 & 2/3 & 0 \right]