Table-and-Graph-Libs/README.md

[![Build Status](https://travis-ci.com/tdulcet/Tables-and-Graphs.svg?branch=master)](https://travis-ci.com/tdulcet/Tables-and-Graphs)

# Tables and Graphs

C++ Console Table and Graph/Plot Libraries

Copyright © 2018 Teal Dulcet

These header only libraries use [box-drawing](https://en.wikipedia.org/wiki/Box-drawing_character#Unicode), [Braille](https://en.wikipedia.org/wiki/Braille_Patterns), [fraction](https://en.wikipedia.org/wiki/Number_Forms) and other Unicode characters and [terminal colors and formatting](https://misc.flogisoft.com/bash/tip_colors_and_formatting) to output tables and graphs/plots to the console. All the tables and graphs are created with a single (one) function call and they do not require any special data structures.

❤️ Please visit [tealdulcet.com](https://www.tealdulcet.com/) to support these libraries and my other software development.

## Tables

### Usage

Complete versions of all of the examples below and more can be found in the [tables.cpp](tables.cpp) file.

Compile with: `g++ -Wall -g -O3 tables.cpp -o tables`.

Run with: `./tables`.

#### Output char array as table

```cpp
#include "tables.hpp"

using namespace std;

int main()
{
	size_t rows = 5;
	size_t columns = 5;

	char ***array;

	// Allocate and set array
	
	tableoptions aoptions;
	aoptions.headerrow = true;
	aoptions.headercolumn = true;

	table(rows, columns, array, NULL, NULL, aoptions);

	// Deallocate array
	
	return 0;
}
```

Table cells can contain [Unicode characters](https://en.wikipedia.org/wiki/List_of_Unicode_characters), but not newlines and tabs.

![](images/char%20array%20to%20table.png)

#### Output array as table with separate header row and column

```cpp
#include "tables.hpp"

using namespace std;

int main()
{
	size_t rows = 4;
	size_t columns = 4;
	
	const char* headerrow[] = {"Header row/column 1", "Header row 2", "Header row 3", "Header row 4", "Header row 5"};
	const char* headercolumn[] = {"Header column 2", "Header column 3", "Header column 4", "Header column 5"};

	char ***array;

	// Allocate and set array
	
	tableoptions aoptions;
	aoptions.headerrow = true;
	aoptions.headercolumn = true;

	table(rows, columns, array, headerrow, headercolumn, aoptions);

	// Deallocate array
	
	return 0;
}
```

Output same as example above.

#### Output array as table

```cpp
#include "tables.hpp"

using namespace std;

int main()
{
	size_t rows = 5;
	size_t columns = 5;

	double **array; // array can be any data type

	// Allocate and set array

	table(rows, columns, array, NULL, NULL, tabledefaultoptions);

	// Deallocate array
	
	return 0;
}
```

![](images/array%20to%20table.png)

#### Output sorted array as table

```cpp
#include <algorithm>
#include "tables.hpp"

using namespace std;

int dimensions; // Number of columns
int sortdimension; // Column to sort by

template <typename T>
bool compare(const T *a, const T *b)
{
	if (a[sortdimension] == b[sortdimension])
		for (int i = 0; i < dimensions; ++i)
			if (sortdimension != i and a[i] != b[i])
				return a[i] < b[i];

	return a[sortdimension] < b[sortdimension];
}

int main()
{
	size_t rows = 5;
	size_t columns = 5;

	int **array; // array can be any data type

	// Allocate and set array
	
	dimensions = columns;
	sortdimension = 0;
	
	sort(array, array + rows, compare<int>);

	table(rows, columns, array, NULL, NULL, tabledefaultoptions);

	// Deallocate array
	
	return 0;
}
```

![](images/sorted%20array%20to%20table.png)

#### Output single function as table

```cpp
#include "tables.hpp"

using namespace std;

double afunction(double x)
{
	return x + 1;
}

int main()
{
	double xmin = -10;
	double xmax = 10;
	double xscl = 2;
	
	tableoptions aoptions;
	aoptions.headerrow = true;
	
	table(xmin, xmax, xscl, afunction, aoptions);
	
	return 0;
}
```

![](images/function%20to%20table.png)

#### Output multiple functions as table

```cpp
#include <cmath>
#include "tables.hpp"

using namespace std;

double function1(double x)
{
	return 2 * x;
}

double function2(double x)
{
	return pow(x, 2);
}

int main()
{
	double xmin = -10;
	double xmax = 10;
	double xscl = 2;
	
	size_t numfunctions = 2;
	
	// Function parameter and return value can be any data type, as long as they are the same
	double (*functions[])(double) = {function1, function2};
	
	tableoptions aoptions;
	aoptions.headerrow = true;
	
	table(xmin, xmax, xscl, numfunctions, functions, aoptions);
	
	return 0;
}
```

![](images/multiple%20functions%20to%20table.png)

### Options

#### Header row

Option: `headerrow`\
Default value: `false`

Header rows are bolded, centered and have a border.

#### Header column

Option: `headercolumn`\
Default value: `false`

Header columns are bolded, centered and have a border.

#### Table border

Option: `tableborder`\
Default value: `true`

#### Cell border

Option: `cellborder`\
Default value: `false`

#### Cell padding

Option: `padding`\
Default value: `1`

#### Alignment

Option: `alignment`\
Values:

* `left` (default)
* `right`

#### bool to alpha

Option: `boolalpha`\
Default value: `false`

#### Title

Option: `title`\
Default value: `NULL`

The title is word wrapped based on the current width of the terminal, using [this](https://gist.github.com/tdulcet/819821ca69501822ad3f84a060c640a0) solution. Handles newlines, tabs and [Unicode characters](https://en.wikipedia.org/wiki/List_of_Unicode_characters).

#### Border style

Option: `style`\
Values:

0. ASCII

	![](images/ASCII%20table.png)
1. Basic

	![](images/basic%20table.png)
2. Light (default)

	![](images/light%20table.png)
3. Heavy

	![](images/heavy%20table.png)
4. Double

	![](images/double%20table.png)
5. Light Dashed

	![](images/light%20dashed%20table.png)
6. Heavy Dashed

	![](images/heavy%20dashed%20table.png)

### Other C++ Console Tables Libraries

* [C++ Text Table](https://github.com/haarcuba/cpp-text-table) (must specify every cell individually in their data structure, limited options, no Unicode support, no header row or column support)
* [Cpp Console Table](https://github.com/Oradle/CppConsoleTable) (must specify every cell individually in their data structure, no Unicode support, no header row or column support)
* [ConsoleTable](https://github.com/766F6964/ConsoleTable) (requires C++11, must specify entire row at once in their data structure, no header column support)

## Graphs/Plots

### Usage

Complete versions of all of the examples below and more can be found in the [graphs.cpp](graphs.cpp) file.

Compile with: `g++ -Wall -g -O3 graphs.cpp -o graphs`.

Run with: `./graphs`.

If `height` is `0`, it will be set to the current height of the terminal (number of rows times four). If `width` is `0`, it will be set to the current width of the terminal (number of columns times two).

#### Output array as plot

```cpp
#include "graphs.hpp"

using namespace std;

int main()
{
	size_t height = 160;
	size_t width = 160;

	long double xmin = -20;
	long double xmax = 20;
	long double ymin = -20;
	long double ymax = 20;

	size_t rows = 10;

	double **array; // array can be any data type, but must have exactly two columns

	// Allocate and set array

	graph(height, width, xmin, xmax, ymin, ymax, rows, array, graphdefaultoptions);

	// Deallocate array
	
	return 0;
}
```

If `xmin` and `xmax` are both `0`, they will be set to the respective minimum and maximum values of x in the array. If `ymin` and `ymax` are both `0`, they will be set to the respective minimum and maximum values of y in the array.

![](images/array%20to%20plot.png)

#### Output single function as graph

```cpp
#include "graphs.hpp"

using namespace std;

double afunction(double x)
{
	return x + 1;
}

int main()
{
	size_t height = 160;
	size_t width = 160;

	long double xmin = -20;
	long double xmax = 20;
	long double ymin = -20;
	long double ymax = 20;

	graph(height, width, xmin, xmax, ymin, ymax, afunction, graphdefaultoptions);
	
	return 0;
}
```

![](images/function%20to%20graph.png)

#### Output multiple functions as graph

```cpp
#include "graphs.hpp"

using namespace std;

double function1(double x)
{
	return 2 * x;
}

double function2(double x)
{
	return pow(x, 2);
}

int main()
{
	size_t height = 160;
	size_t width = 160;

	long double xmin = -20;
	long double xmax = 20;
	long double ymin = -20;
	long double ymax = 20;
	
	size_t numfunctions = 2;
	
	// Function parameter and return value can be any data type, as long as they are the same
	double (*functions[])(double) = {function1, function2};

	graph(height, width, xmin, xmax, ymin, ymax, numfunctions, functions, graphdefaultoptions);
	
	return 0;
}
```

![](images/multiple%20functions%20to%20graph.png)

### Options

#### Border/Axis

Option: `border`\
Default value: `true`

#### Axis labels

Option: `axislabel`\
Default value: `true`

Requires `border` to be `true`.

#### Axis units labels

Option: `axisunitslabel`\
Default value: `true`

Requires `border` and `axislabel` to be `true`.

#### Title

Option: `title`\
Default value: `NULL`

The title is word wrapped based on the current width of the terminal, using [this](https://gist.github.com/tdulcet/819821ca69501822ad3f84a060c640a0) solution. Handles newlines, tabs and [Unicode characters](https://en.wikipedia.org/wiki/List_of_Unicode_characters).

#### Axis/Border style

Option: `style`\
Values:

0. ASCII

	![](images/ASCII%20graph.png)
1. Basic

	![](images/basic%20graph.png)
2. Light (default)

	![](images/light%20graph.png)
3. Heavy

	![](images/heavy%20graph.png)
4. Double

	![](images/double%20graph.png)
5. Light Dashed

	![](images/light%20dashed%20graph.png)
6. Heavy Dashed

	![](images/heavy%20dashed%20graph.png)

#### Graph/Plot Color

Option: `color`\
Values:

0. System default
1. Black
2. Red (default)
3. Green
4. Yellow
5. Blue
6. Cyan
7. Light gray
8. Dark gray
9. Light red
10. Light green
11. Light yellow
12. Light blue
13. Light cyan
14. White

See [here](https://misc.flogisoft.com/bash/tip_colors_and_formatting#foreground_text) for examples of the colors.

Only used for plots and when graphing a single function.

When graphing multiple functions, colors `2` - `14` are used inorder. Color `0` is used where the functions cross.

##### Plot

![](images/plot%20colors.png)

##### Graph

![](images/graph%20colors.png)

### Other C++ Console Graphs/Plots Libraries

* [C++ terminal plotting library](https://github.com/fbbdev/plot) (requires C++14, based on [UnicodePlots.jl](https://github.com/Evizero/UnicodePlots.jl), no documentation and very difficult to use, although supports animations)

## Contributing

Pull requests welcome! Ideas for contributions:

* Add more options
	* Add an option to print a border around graphs/plots
	* Add options to word wrap and truncate long text in table cells
* Add more examples
* Improve the performance
* Handle newlines, tabs and formatted text in the tables
* Handle formatted text in the table and graph/plot titles
* Support more graph/plot colors
	* Support combining colors when functions cross
* Support plotting multiple arrays of different sizes
* Update the `-t, --table` options of column command from [util-linux](https://en.wikipedia.org/wiki/Util-linux) to use the Table library
* Create a new CLI tool that uses the Graph library
* Port to other languages (C, Java, Rust, etc.)