Construct an empty set.

Construct a set with a single value.

Examples

let set = OrdSet::singleton(123);
assert!(set.contains(&123));

Test whether a set is empty.

Time: O(1)

Examples

assert!(
  !ordset![1, 2, 3].is_empty()
);
assert!(
  OrdSet::<i32>::new().is_empty()
);

Get the size of a set.

Time: O(1)

Examples

assert_eq!(3, ordset![1, 2, 3].len());

Get the smallest value in a set.

If the set is empty, returns None.

Get the largest value in a set.

If the set is empty, returns None.

Insert a value into a set.

Time: O(log n)

Examples

let set = ordset![456];
assert_eq!(
  set.insert(123),
  ordset![123, 456]
);

Insert a value into a set.

This is a copy-on-write operation, so that the parts of the set's structure which are shared with other sets will be safely copied before mutating.

Time: O(log n)

Examples

let mut set = ordset!{};
set.insert_mut(123);
set.insert_mut(456);
assert_eq!(
  set,
  ordset![123, 456]
);

Test if a value is part of a set.

Time: O(log n)

Remove a value from a set.

Time: O(log n)

Remove a value from a set.

This is a copy-on-write operation, so that the parts of the set's structure which are shared with other sets will be safely copied before mutating.

Time: O(log n)

Construct the union of two sets.

Construct the union of multiple sets.

Construct the difference between two sets.

Construct the intersection of two sets.

Split a set into two, with the left hand set containing values which are smaller than split, and the right hand set containing values which are larger than split.

The split value itself is discarded.

Split a set into two, with the left hand set containing values which are smaller than split, and the right hand set containing values which are larger than split.

Returns a tuple of the two maps and a boolean which is true if the split value existed in the original set, and false otherwise.

Test whether a set is a subset of another set, meaning that all values in our set must also be in the other set.

Test whether a set is a proper subset of another set, meaning that all values in our set must also be in the other set. A proper subset must also be smaller than the other set.

Construct a set with only the n smallest values from a given set.

Construct a set with the n smallest values removed from a given set.

Remove the smallest value from a set, and return that value as well as the updated set.

Remove the largest value from a set, and return that value as well as the updated set.

Discard the smallest value from a set, returning the updated set.

Discard the largest value from a set, returning the updated set.