Crate swap3

Source
Expand description

§swap3

Provides utility functions for simultaneously swapping three values by rotating them either left (abcbca) or right (abccab). These functions can come in handy e.g. when rotating elements of a binary tree in list representation.

The provided functions work on arbitrary types and do not require the type to be Clone, Copy or Default.

§Crate features

  • unsafe - The unsafe feature enables the use of (potentially faster) unsafe code. It is disabled by default; when disabled, forbid(unsafe_code) is implied.

§Examples

For individual references, the swap3_bca (rotate left) and swap3_cab (rotate right) functions are available:

let mut a = 10;
let mut b = 20;
let mut c = 30;

swap3::swap3_bca(&mut a, &mut b, &mut c);
assert_eq!([a, b, c], [20, 30, 10]);

For slices, the swap3_bca_slice and swap3_cab_slice functions can be used:

let mut vec = vec![10, 20, 30, 40, 50, 60];
swap3::swap3_bca_slice(&mut vec, 0, 1, 4);
assert_eq!(vec, &[20, 50, 30, 40, 10, 60]);

… or using the Swap3 trait imported from the prelude:

use swap3::prelude::*;

let mut vec = vec![10, 20, 30, 40, 50, 60];
vec.swap3_bca(0, 1, 4);
assert_eq!(vec, &[20, 50, 30, 40, 10, 60]);

Modules§

prelude
Provides simple access to commonly used traits.
slice

Traits§

Swap3
Trait providing the Swap3::swap3_bca and Swap3::swap3_cab functions directly.

Functions§

swap3_bca
Rotates three values to the left.
swap3_bca_slice
Rotates three values to the left.
swap3_cab
Rotates three values to the right.
swap3_cab_slice
Rotates three values to the right.