Functions for initializing GenGrid structures. More...

#include "gensvm_grid.h"

Include dependency graph for gensvm_grid.c:

Functions
struct GenGrid *	gensvm_init_grid (void)
	Initialize a GenGrid structure. More...

void	gensvm_free_grid (struct GenGrid *grid)
	Free a GenGrid structure. More...

Detailed Description

Functions for initializing GenGrid structures.

Author: G.J.J. van den Burg

Date: 2016-05-01

This file contains functions for initializing and freeing a GenGrid instance. In addition, default values for this structure are defined here (and only here).

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_grid.c.

Function Documentation

◆ gensvm_free_grid()

void gensvm_free_grid ( struct GenGrid * grid )

Free a GenGrid structure.

This function frees all elements of a GenGrid structure, including the GenGrid structure itself. The provided argument is set to NULL on exit.

Parameters

[in] grid a GenGrid struct to free

Definition at line 88 of file gensvm_grid.c.

◆ gensvm_init_grid()

struct GenGrid* gensvm_init_grid ( void )

Initialize a GenGrid structure.

This function is used to initialize a GenGrid struct, and set its default parameters. A pointer to the generated struct is returned.

Returns: initialized GenGrid struct

Definition at line 44 of file gensvm_grid.c.