Vector library - list definition. More...

#include <stdlib.h>
#include <grass/vector.h>

Include dependency graph for vector/Vlib/list.c:

Functions
struct ilist *	Vect_new_list (void)
	Creates and initializes a struct ilist. More...

int	Vect_reset_list (struct ilist *list)
	Reset ilist structure. More...

void	Vect_destroy_list (struct ilist *list)
	Frees all memory associated with a struct ilist, including the struct itself. More...

int	Vect_list_append (struct ilist *list, int val)
	Append new item to the end of list if not yet present. More...

int	Vect_list_append_list (struct ilist alist, const struct ilist blist)
	Append new items to the end of list if not yet present. More...

int	Vect_list_delete (struct ilist *list, int val)
	Remove a given value (item) from list. More...

int	Vect_list_delete_list (struct ilist alist, const struct ilist blist)
	Delete list from existing list. More...

int	Vect_val_in_list (const struct ilist *list, int val)
	Find a given item in the list. More...

struct boxlist *	Vect_new_boxlist (int have_boxes)
	Creates and initializes a struct boxlist. More...

int	Vect_reset_boxlist (struct boxlist *list)
	Reset boxlist structure. More...

void	Vect_destroy_boxlist (struct boxlist *list)
	Frees all memory associated with a struct boxlist, including the struct itself. More...

int	Vect_boxlist_append (struct boxlist list, int id, const struct bound_box box)
	Append new item to the end of list if not yet present. More...

int	Vect_boxlist_append_boxlist (struct boxlist alist, const struct boxlist blist)
	Append new items to the end of list if not yet present. More...

int	Vect_boxlist_delete (struct boxlist *list, int id)
	Remove a given value (item) from list. More...

int	Vect_boxlist_delete_boxlist (struct boxlist alist, const struct boxlist blist)
	Delete list from existing list. More...

int	Vect_val_in_boxlist (const struct boxlist *list, int id)
	Find a given item in the list. More...

Detailed Description

Vector library - list definition.

Higher level functions for reading/writing/manipulating vectors.

This program is free software under the GNU General Public License (>=v2). Read the file COPYING that comes with GRASS for details.

Author: Original author CERL, probably Dave Gerdes or Mike Higgins.; Update to GRASS 5.7 Radim Blazek and David D. Gray; Update to GRASS 7 Markus Metz

Definition in file vector/Vlib/list.c.

Function Documentation

◆ Vect_boxlist_append()

int Vect_boxlist_append	(	struct boxlist *	list,
		int	id,
		const struct bound_box *	box
	)

Append new item to the end of list if not yet present.

Parameters

[in,out]	list	pointer to ilist structure
	id	new item to append to the end of list
	box	bounding box

Returns: 0 on success; 1 on error

Definition at line 288 of file vector/Vlib/list.c.

References boxlist::alloc_values, boxlist::box, G_realloc, boxlist::have_boxes, boxlist::id, boxlist::n_values, and NULL.

Referenced by Vect_boxlist_append_boxlist().

◆ Vect_boxlist_append_boxlist()

int Vect_boxlist_append_boxlist	(	struct boxlist *	alist,
		const struct boxlist *	blist
	)

Append new items to the end of list if not yet present.

Parameters

[in,out]	alist	pointer to boxlist structure where items will be appended
	blist	pointer to boxlist structure with new items

Returns: 0 on success; 1 on error

Definition at line 330 of file vector/Vlib/list.c.

References bound_box::B, boxlist::box, bound_box::E, boxlist::have_boxes, boxlist::id, bound_box::N, boxlist::n_values, NULL, bound_box::S, bound_box::T, Vect_boxlist_append(), and bound_box::W.

◆ Vect_boxlist_delete()

int Vect_boxlist_delete	(	struct boxlist *	list,
		int	id
	)

Remove a given value (item) from list.

Parameters

[in,out]	list	pointer to boxlist structure
	id	to remove

Returns: 0 on success; 1 on error

Definition at line 361 of file vector/Vlib/list.c.

References boxlist::box, boxlist::have_boxes, boxlist::id, boxlist::n_values, and NULL.

Referenced by Vect_boxlist_delete_boxlist().

◆ Vect_boxlist_delete_boxlist()

int Vect_boxlist_delete_boxlist	(	struct boxlist *	alist,
		const struct boxlist *	blist
	)

Delete list from existing list.

Parameters

[in,out]	alist	pointer to original boxlist structure,
	blist	pointer to boxlist structure with items to delete

Returns: 0 on success; 1 on error

Definition at line 393 of file vector/Vlib/list.c.

References boxlist::id, boxlist::n_values, NULL, and Vect_boxlist_delete().

◆ Vect_destroy_boxlist()

void Vect_destroy_boxlist ( struct boxlist * list )

Frees all memory associated with a struct boxlist, including the struct itself.

Parameters

[in,out] list pointer to ilist structure

Definition at line 265 of file vector/Vlib/list.c.

References boxlist::alloc_values, boxlist::box, G_free(), boxlist::id, and NULL.

◆ Vect_destroy_list()

void Vect_destroy_list ( struct ilist * list )

Frees all memory associated with a struct ilist, including the struct itself.

Parameters

[in,out] list pointer to ilist structure

Definition at line 70 of file vector/Vlib/list.c.

References ilist::alloc_values, G_free(), NULL, and ilist::value.

◆ Vect_list_append()

int Vect_list_append	(	struct ilist *	list,
		int	val
	)

Append new item to the end of list if not yet present.

Parameters

[in,out]	list	pointer to ilist structure
	val	new item to append to the end of list

Returns: 0 on success; 1 on error

Definition at line 90 of file vector/Vlib/list.c.

References ilist::alloc_values, G_realloc, ilist::n_values, NULL, and ilist::value.

Referenced by Vect_field_cat_get(), and Vect_list_append_list().

◆ Vect_list_append_list()

int Vect_list_append_list	(	struct ilist *	alist,
		const struct ilist *	blist
	)

Append new items to the end of list if not yet present.

Parameters

[in,out]	alist	pointer to ilist structure where items will be appended
	blist	pointer to ilist structure with new items

Returns: 0 on success; 1 on error

Definition at line 124 of file vector/Vlib/list.c.

References ilist::n_values, NULL, ilist::value, and Vect_list_append().

◆ Vect_list_delete()

int Vect_list_delete	(	struct ilist *	list,
		int	val
	)

Remove a given value (item) from list.

Parameters

[in,out]	list	pointer to ilist structure
	val	to remove

Returns: 0 on success; 1 on error

Definition at line 146 of file vector/Vlib/list.c.

References ilist::n_values, NULL, and ilist::value.

Referenced by Vect_list_delete_list().

◆ Vect_list_delete_list()

int Vect_list_delete_list	(	struct ilist *	alist,
		const struct ilist *	blist
	)

Delete list from existing list.

Parameters

[in,out]	alist	pointer to original ilist structure,
	blist	pointer to ilist structure with items to delete

Returns: 0 on success; 1 on error

Definition at line 175 of file vector/Vlib/list.c.

References ilist::n_values, NULL, ilist::value, and Vect_list_delete().

◆ Vect_new_boxlist()

struct boxlist* Vect_new_boxlist ( int have_boxes )

Creates and initializes a struct boxlist.

This structure is used as container for bounding boxes with id. The library routines handle all memory allocation.

Parameters

have_boxes if set to 0, the list will hold only ids and no boxes

Returns: pointer to struct boxlist; NULL on error

Definition at line 225 of file vector/Vlib/list.c.

References boxlist::alloc_values, boxlist::box, G_malloc, boxlist::have_boxes, boxlist::id, boxlist::n_values, and NULL.

Referenced by Vect_attach_isles(), and Vect_find_area().

◆ Vect_new_list()

struct ilist* Vect_new_list ( void )

Creates and initializes a struct ilist.

This structure is used as container for integer values. The library routines handle all memory allocation.

Returns: pointer to struct ilist; NULL on error

Definition at line 32 of file vector/Vlib/list.c.

References ilist::alloc_values, G_malloc, ilist::n_values, NULL, and ilist::value.

Referenced by NetA_betweenness_closeness(), Vect_find_node(), Vect_select_areas_by_polygon(), and Vedit_extend_lines().

◆ Vect_reset_boxlist()

int Vect_reset_boxlist ( struct boxlist * list )

Reset boxlist structure.

To make sure boxlist structure is clean to be re-used. List must have previously been created with Vect_new_boxlist().

Parameters

[in,out] list pointer to struct boxlist

Returns: 0

Definition at line 252 of file vector/Vlib/list.c.

References boxlist::n_values.

◆ Vect_reset_list()

int Vect_reset_list ( struct ilist * list )

Reset ilist structure.

To make sure ilist structure is clean to be re-used. List must have previously been created with Vect_new_list().

Parameters

[in,out] list pointer to struct ilist

Returns: 0

Definition at line 57 of file vector/Vlib/list.c.

References ilist::n_values.

Referenced by Vect_field_cat_get(), Vect_select_areas_by_polygon(), Vect_select_nodes_by_box(), and Vect_spatial_index_select().

◆ Vect_val_in_boxlist()

int Vect_val_in_boxlist	(	const struct boxlist *	list,
		int	id
	)

Find a given item in the list.

Parameters

list	pointer to boxlist structure
id	value of item

Returns: 1 if an item is found; 0 no found item in the list

Definition at line 415 of file vector/Vlib/list.c.

References boxlist::id, boxlist::n_values, and NULL.

◆ Vect_val_in_list()

int Vect_val_in_list	(	const struct ilist *	list,
		int	val
	)

Find a given item in the list.

Parameters

list	pointer to ilist structure
val	value of item

Returns: 1 if an item is found; 0 no found item in the list

Definition at line 197 of file vector/Vlib/list.c.

References ilist::n_values, NULL, and ilist::value.

Functions

Detailed Description

Function Documentation

◆ Vect_boxlist_append()

◆ Vect_boxlist_append_boxlist()

◆ Vect_boxlist_delete()

◆ Vect_boxlist_delete_boxlist()

◆ Vect_destroy_boxlist()

◆ Vect_destroy_list()

◆ Vect_list_append()

◆ Vect_list_append_list()

◆ Vect_list_delete()

◆ Vect_list_delete_list()

◆ Vect_new_boxlist()

◆ Vect_new_list()

◆ Vect_reset_boxlist()

◆ Vect_reset_list()

◆ Vect_val_in_boxlist()

◆ Vect_val_in_list()