Various print functions for printing to output streams. More...

#include "gensvm_print.h"

Include dependency graph for gensvm_print.c:

Functions
void	note (const char *fmt,...)
	Parse a formatted string and write to the output stream. More...

void	err (const char *fmt,...)
	Parse a formatted string and write it to standard error. More...

Variables
FILE *	GENSVM_OUTPUT_FILE = NULL

FILE *	GENSVM_ERROR_FILE = NULL

Detailed Description

Various print functions for printing to output streams.

Author: G.J.J. van den Burg

Date: 2014-01-07

This file contains several utility functions for coordinating input and output of data and model files. It also contains string functions.

Copyright: Copyright 2016, G.J.J. van den Burg.

This file is part of GenSVM.

GenSVM is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

GenSVM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with GenSVM. If not, see http://www.gnu.org/licenses/.

Definition in file gensvm_print.c.

Function Documentation

◆ err()

void err	(	const char *	fmt,
			...
	)

Parse a formatted string and write it to standard error.

Shorthand for fprintf(GENSVM_ERROR_FILE, ...)

Parameters

[in]	fmt	string format
[in]	...	variable argument list for the string format

Definition at line 84 of file gensvm_print.c.

◆ note()

void note	(	const char *	fmt,
			...
	)

Parse a formatted string and write to the output stream.

This function is a replacement of fprintf(), such that the output stream does not have to be specified at each function call. The functionality is exactly the same however.

Parameters

[in]	fmt	String format
[in]	...	variable argument list for the string format

Definition at line 62 of file gensvm_print.c.

Variable Documentation

◆ GENSVM_ERROR_FILE

FILE* GENSVM_ERROR_FILE = NULL

The GENSVM_ERROR_FILE specifies the output stream to use when writing an error. Typically this is stderr, but when unit testing we can temporarily redirect this to check if the correct output is written.

Definition at line 43 of file gensvm_print.c.

◆ GENSVM_OUTPUT_FILE

FILE* GENSVM_OUTPUT_FILE = NULL

The GENSVM_OUTPUT_FILE specifies the output stream to which all output is written. This is done through the function note(). The advantage of using a global output stream variable is that the output can temporarily be suppressed by importing this variable through extern and (temporarily) setting it to NULL.

Definition at line 33 of file gensvm_print.c.

Functions