# Struct im::OrdSet

``pub struct OrdSet<A> { /* private fields */ }``
Expand description

An ordered set.

An immutable ordered set implemented as a [B-tree] 1.

Most operations on this type of set are O(log n). A `HashSet` is usually a better choice for performance, but the `OrdSet` has the advantage of only requiring an `Ord` constraint on its values, and of being ordered, so values always come out from lowest to highest, where a `HashSet` has no guaranteed ordering.

## Implementations

Construct an empty set.

Construct a set with a single value.

##### Examples
``````let set = OrdSet::unit(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());``

Test whether two sets refer to the same content in memory.

This is true if the two sides are references to the same set, or if the two sets refer to the same root node.

This would return true if you’re comparing a set to itself, or if you’re comparing a set to a fresh clone of itself.

Time: O(1)

Discard all elements from the set.

This leaves you with an empty set, and all elements that were previously inside it are dropped.

Time: O(n)

##### Examples
``````let mut set = ordset![1, 2, 3];
set.clear();
assert!(set.is_empty());``````

Get the smallest value in a set.

If the set is empty, returns `None`.

Time: O(log n)

Get the largest value in a set.

If the set is empty, returns `None`.

Time: O(log n)

Create an iterator over the contents of the set.

Create an iterator over a range inside the set.

Get an iterator over the differences between this set and another, i.e. the set of entries to add or remove to this set in order to make it equal to the other set.

This function will avoid visiting nodes which are shared between the two sets, meaning that even very large sets can be compared quickly if most of their structure is shared.

Time: O(n) (where n is the number of unique elements across the two sets, minus the number of elements belonging to nodes shared between them)

Test if a value is part of a set.

Time: O(log n)

##### Examples
``````let mut set = ordset!{1, 2, 3};
assert!(set.contains(&1));
assert!(!set.contains(&4));``````

Get the closest smaller value in a set to a given value.

If the set contains the given value, this is returned. Otherwise, the closest value in the set smaller than the given value is returned. If the smallest value in the set is larger than the given value, `None` is returned.

##### Examples
``````let set = ordset![1, 3, 5, 7, 9];
assert_eq!(Some(&5), set.get_prev(&6));``````

Get the closest larger value in a set to a given value.

If the set contains the given value, this is returned. Otherwise, the closest value in the set larger than the given value is returned. If the largest value in the set is smaller than the given value, `None` is returned.

##### Examples
``````let set = ordset![1, 3, 5, 7, 9];
assert_eq!(Some(&5), set.get_next(&4));``````

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

Time: O(n log m) where m is the size of 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.

Time: O(n log m) where m is the size of the other set

Insert a value into a set.

Time: O(log n)

##### Examples
``````let mut set = ordset!{};
set.insert(123);
set.insert(456);
assert_eq!(
set,
ordset![123, 456]
);``````

Remove a value from a set.

Time: O(log n)

Remove the smallest value from a set.

Time: O(log n)

Remove the largest value from a set.

Time: O(log n)

Construct a new set from the current set with the given value added.

Time: O(log n)

##### Examples
``````let set = ordset!;
assert_eq!(
set.update(123),
ordset![123, 456]
);``````

Construct a new set with the given value removed if it’s in the set.

Time: O(log n)

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

Time: O(log n)

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

Time: O(log n)

Construct the union of two sets.

Time: O(n log n)

##### Examples
``````let set1 = ordset!{1, 2};
let set2 = ordset!{2, 3};
let expected = ordset!{1, 2, 3};
assert_eq!(expected, set1.union(set2));``````

Construct the union of multiple sets.

Time: O(n log n)

Construct the symmetric difference between two sets.

This is an alias for the `symmetric_difference` method.

Time: O(n log n)

##### Examples
``````let set1 = ordset!{1, 2};
let set2 = ordset!{2, 3};
let expected = ordset!{1, 3};
assert_eq!(expected, set1.difference(set2));``````

Construct the symmetric difference between two sets.

Time: O(n log n)

##### Examples
``````let set1 = ordset!{1, 2};
let set2 = ordset!{2, 3};
let expected = ordset!{1, 3};
assert_eq!(expected, set1.symmetric_difference(set2));``````

Construct the relative complement between two sets, that is the set of values in `self` that do not occur in `other`.

Time: O(m log n) where m is the size of the other set

##### Examples
``````let set1 = ordset!{1, 2};
let set2 = ordset!{2, 3};
let expected = ordset!{1};
assert_eq!(expected, set1.relative_complement(set2));``````

Construct the intersection of two sets.

Time: O(n log n)

##### Examples
``````let set1 = ordset!{1, 2};
let set2 = ordset!{2, 3};
let expected = ordset!{2};
assert_eq!(expected, set1.intersection(set2));``````

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.

Time: O(n)

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 sets and a boolean which is true if the `split` value existed in the original set, and false otherwise.

Time: O(n)

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

Time: O(n)

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

Time: O(n)

## Trait Implementations

The resulting type after applying the `+` operator.

Performs the `+` operation. Read more

The resulting type after applying the `+` operator.

Performs the `+` operation. Read more

Return an arbitrary value. Read more

Return an iterator of values that are smaller than itself. Read more

Generate an arbitrary value of `Self` from the given unstructured data. Read more

Generate an arbitrary value of `Self` from the entirety of the given unstructured data. Read more

Get a size hint for how many bytes out of an `Unstructured` this type needs to construct itself. Read more

Clone a set.

Time: O(1)

Performs copy-assignment from `source`. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Deserialize this value from the given Serde deserializer. Read more

Extends a collection with the contents of an iterator. Read more

🔬 This is a nightly-only experimental API. (`extend_one`)

Extends a collection with exactly one element.

🔬 This is a nightly-only experimental API. (`extend_one`)

Reserves capacity in a collection for the given number of additional elements. Read more

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Creates a value from an iterator. Read more

Feeds this value into the given `Hasher`. Read more

Feeds a slice of this type into the given `Hasher`. Read more

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

The resulting type after applying the `*` operator.

Performs the `*` operation. Read more

The resulting type after applying the `*` operator.

Performs the `*` operation. Read more

This method returns an `Ordering` between `self` and `other`. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

This method tests for `!=`.

This method returns an ordering between `self` and `other` values if one exists. Read more

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

Serialize this value into the given Serde serializer. Read more

Method which takes an iterator and generates `Self` from the elements by “summing up” the items. Read more

## Blanket Implementations

Gets the `TypeId` of `self`. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

The alignment of pointer.

The type for initializers.

Initializes a with the given initializer. Read more

Dereferences the given pointer. Read more

Mutably dereferences the given pointer. Read more

Drops the object pointed to by the given pointer. Read more

Should always be `Self`

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.