set.h File Reference

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "kapi.h"

Go to the source code of this file.

Classes
struct	set

Functions
void	set_initialize (struct set *const set)
bool	set_add (struct set *const set, uint32_t item)
bool	set_rm (struct set *const set, uint32_t item)
bool	set_contains (struct set *set, uint32_t item)
bool	list_contains (uint32_t const *const list, const size_t size, const uint32_t item)

Detailed Description

Kernel-allocated thread-safe simple sets header

See common/set.c for discussion

Copyright

Copyright (c) 2017-2024, Purdue University ACM SIGBots. All rights reserved.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Function Documentation

list_contains()

bool list_contains	(	uint32_t const *const	list,
		const size_t	size,
		const uint32_t	item )

Checks if the list contains an item

Parameters

list	A pointer to a list of words
size	The number of items in the list
item	The item to check

Returns

True if the item is in the list

set_add()

bool set_add	(	struct set *const	set,
		uint32_t	item )

Adds item to the set if it didn't already exist

Parameters

set	A pointer to the set structure
item	Item to add to the set

Returns

Ttrue if the item was added to the set or was already present

set_contains()

bool set_contains	(	struct set *	set,
		uint32_t	item )

Checks if the set contains an item

Parameters

set	A pointer to the set structure
item	The item to check

Returns

True if the item is in the set

set_initialize()

void set_initialize

(

struct set *const

set

)

Initializes a a set.

Parameters

set	A pointer to a set structure

set_rm()

bool set_rm	(	struct set *const	set,
		uint32_t	item )

Removes an item from the set

Parameters

set	A pointer to the set structure
item	The item to remove

Returns

True if the item was removed (or was already not present)