Sets

Usage

Insert into your Cargo.toml file [dependencies] section:

sets = "^0.1"

Import into your source file(s) macro here, structs and functions, as needed.

use sets::{here,Set,OrderedSet,IndexedSet,RankedSet,SetOps};

See tests/tests.rs for examples of usage.

Description

Sets consists mostly of structs Set, OrderedSet, IndexedSet, RankedSet , which are type-safe wrappers for the more primitive functions and methods of crate indxvec.

The main capabilities of sets include: efficient sorting, ranking, merging, searching and indices manipulations. More set operations will be added in future releases. The structs contain generic vectors Vec<T> and/or generic slices &[T]. Thus they will work with vectors/slices of primitive types but also on any arbitrarily complex end type T. As long as the required traits, mostly just PartialOrd and Copy, are implemented for T.

Functions

The initiation and conversion functions are associated with their structs: Set, OrderedSet, IndexedSet, RankedSet. Thus they need to be called as in: Set::from_slice(&v);
Some additional helper functions are in the module src/functions.rs.

Trait SetOps

Implements set operations: infsup, member, search, union, intersection, complement for all four types of sets. Generally speaking, these are faster (more efficient) for the ordered and especially indexed sets, rather than for the unordered sets. For example, member is then able to use the binary search.

Release Notes (Latest First)

Version 0.1.2 - implemented SetOps trait for struct Set. The other three structs will follow in the next version.

Version 0.1.1 - competed the associated functions for all initiations and conversions of the four set structs.