apop_output.c File Reference

Defines

• #define Output_vars   output_file, output_pipe, output_type, output_append
• #define Output_declares   char * output_file, FILE * output_pipe, char output_type, char output_append
• #define Dispatch_output

Functions

• void apop_prep_output (char **output_file, FILE **output_pipe, char *output_type, char *output_append)
• void apop_plot_line_and_scatter (apop_data *data, apop_model *est, Output_declares)
• void apop_histogram_plot (apop_model *hist, Output_declares)
• void apop_plot_histogram (gsl_vector *data, size_t bins, Output_declares)
• void apop_histogram_print (apop_model *h, Output_declares)
• void apop_data_show (const apop_data *in)
• void p_fn (FILE *f, double data)
• void apop_vector_print (gsl_vector *data, Output_declares)
• void apop_vector_show (const gsl_vector *data)
• void apop_data_print (const apop_data *data, Output_declares)
• void apop_matrix_print (const gsl_matrix *data, Output_declares)
• void apop_matrix_show (const gsl_matrix *data)
• void apop_plot_lattice (const apop_data *d, Output_declares)
• void apop_plot_qq (gsl_vector *v, apop_model *m, Output_declares, size_t bins, gsl_rng *r)
• void apop_plot_triangle (apop_data *in, Output_declares)

---

Detailed Description

Some printing and output interface functions.

---

Define Documentation

#define Dispatch_output

Value:

char * apop_varad_var(output_file, NULL);                 \
    FILE * apop_varad_var(output_pipe, NULL);                 \
    char apop_varad_var(output_type, 0);                      \
    char apop_varad_var(output_append, 0);                    \
    apop_prep_output(&output_file, &output_pipe, &output_type, &output_append);

---

Function Documentation

void apop_histogram_print	(	apop_model *	h,
		Output_declares
	)

Print an apop_histogram. Put a "plot '-'\n" before this, and you can send it straight to Gnuplot. The -inf and +inf elements are not printed.

Parameters:

h

The input histogram (no default, must not be NULL.)

This function uses the Designated initializers syntax for inputs.

void apop_plot_qq	(	gsl_vector *	v,
		apop_model *	m,
		Output_declares	,
		size_t	bins,
		gsl_rng *	r
	)

Plot the percentiles of a data set against the percentiles of a distribution.

The distribution percentiles will be on the $x$-axis, your data percentiles on the $y$-.

The function respects the apop_opts.output_type option. It uses the Designated initializers syntax for inputs.

Parameters:

	v	The data (No default, must not be NULL.)
	m	The distribution, such as apop_normal. I'll be using the draw method. (Default = best-fitting Normal)
	bins	The number of bins in the histogram. The number of points on the plot will always be 101 (i.e. percentiles). (default = MAX(10, data->size/10); denominator subject to future adjustment)
	r	A gsl_rng. If NULL, I'll take care of the RNG; see Auto-allocated RNGs. (Default = NULL)

void apop_plot_triangle	(	apop_data *	in,
		Output_declares
	)

This produces a nifty triangle plot from an input matrix with three columns. Each row is plotted inside an equilateral triangle such that (1, 0, 0) is the lower left corner, (0, 1, 0) the lower right corner, and (0, 0, 1) the middle, upper corner.

A triangle plot with a smattering of data points.

• Gnuplot will rescale for you, so you don't need to worry about whether the row sums to one.
• This function uses the Designated initializers syntax for inputs.
• This function respects the global apop_opts.output_type and apop_opts.output_pipe variables; see the legible output section of the outline for details.