Skip to content

A more consistent API naming scheme #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

A more consistent API naming scheme #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "bimap"
version = "0.6.3"
version = "0.7.0"
authors = ["Billy Rieger <[email protected]>"]
description = "Bijective maps"
repository = "https://github.com/billyrieger/bimap-rs/"
Expand Down
68 changes: 34 additions & 34 deletions src/btree.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,11 +143,11 @@ where
/// bimap.insert('b', 2);
/// bimap.insert('c', 3);
///
/// for char_value in bimap.left_values() {
/// for char_value in bimap.values_left() {
/// println!("{}", char_value);
/// }
/// ```
pub fn left_values(&self) -> LeftValues<'_, L, R> {
pub fn values_left(&self) -> LeftValues<'_, L, R> {
LeftValues {
inner: self.left2right.iter(),
}
Expand All @@ -168,11 +168,11 @@ where
/// bimap.insert('b', 2);
/// bimap.insert('c', 3);
///
/// for int_value in bimap.right_values() {
/// for int_value in bimap.values_right() {
/// println!("{}", int_value);
/// }
/// ```
pub fn right_values(&self) -> RightValues<'_, L, R> {
pub fn values_right(&self) -> RightValues<'_, L, R> {
RightValues {
inner: self.right2left.iter(),
}
Expand Down Expand Up @@ -514,11 +514,11 @@ where
/// bimap.insert('c', 3);
/// bimap.insert('d', 4);
///
/// for (left, right) in bimap.left_range('b'..'d') {
/// for (left, right) in bimap.range_left('b'..'d') {
/// println!("({}, {})", left, right);
/// }
/// ```
pub fn left_range<T, A>(&self, range: A) -> LeftRange<'_, L, R>
pub fn range_left<T, A>(&self, range: A) -> LeftRange<'_, L, R>
where
L: Borrow<T>,
A: RangeBounds<T>,
Expand Down Expand Up @@ -551,11 +551,11 @@ where
/// bimap.insert('c', 3);
/// bimap.insert('d', 4);
///
/// for (left, right) in bimap.right_range(2..4) {
/// for (left, right) in bimap.range_right(2..4) {
/// println!("({}, {})", left, right);
/// }
/// ```
pub fn right_range<T, A>(&self, range: A) -> RightRange<'_, L, R>
pub fn range_right<T, A>(&self, range: A) -> RightRange<'_, L, R>
where
R: Borrow<T>,
A: RangeBounds<T>,
Expand Down Expand Up @@ -864,9 +864,9 @@ impl<'a, L, R> Iterator for RightValues<'a, L, R> {

/// An iterator over a range of left-right pairs in a `BiBTreeMap`.
///
/// This struct is created by the [`left_range`] method of `BiBTreeMap`.
/// This struct is created by the [`range_left`] method of `BiBTreeMap`.
///
/// [`left_range`]: BiBTreeMap::left_range
/// [`range_left`]: BiBTreeMap::range_left
#[derive(Debug, Clone)]
pub struct LeftRange<'a, L, R> {
inner: btree_map::Range<'a, Ref<L>, Ref<R>>,
Expand Down Expand Up @@ -896,9 +896,9 @@ impl<'a, L, R> Iterator for LeftRange<'a, L, R> {

/// An iterator over a range of left-right pairs in a `BiBTreeMap`.
///
/// This struct is created by the [`right_range`] method of `BiBTreeMap`.
/// This struct is created by the [`range_right`] method of `BiBTreeMap`.
///
/// [`right_range`]: BiBTreeMap::right_range
/// [`range_right`]: BiBTreeMap::range_right
#[derive(Debug, Clone)]
pub struct RightRange<'a, L, R> {
inner: btree_map::Range<'a, Ref<R>, Ref<L>>,
Expand Down Expand Up @@ -1114,7 +1114,7 @@ mod tests {
bimap.insert('a', 3);
bimap.insert('b', 2);
bimap.insert('c', 1);
let left_values = bimap.left_values().cloned().collect::<Vec<_>>();
let left_values = bimap.values_left().cloned().collect::<Vec<_>>();
assert_eq!(left_values, vec!['a', 'b', 'c'])
}

Expand All @@ -1125,7 +1125,7 @@ mod tests {
bimap.insert('b', 2);
bimap.insert('c', 1);

let mut iter = bimap.left_values();
let mut iter = bimap.values_left();
assert_eq!(iter.next_back(), Some(&'c'));
assert_eq!(iter.next_back(), Some(&'b'));
assert_eq!(iter.next_back(), Some(&'a'));
Expand All @@ -1137,7 +1137,7 @@ mod tests {
bimap.insert('a', 3);
bimap.insert('b', 2);
bimap.insert('c', 1);
let right_values = bimap.right_values().cloned().collect::<Vec<_>>();
let right_values = bimap.values_right().cloned().collect::<Vec<_>>();
assert_eq!(right_values, vec![1, 2, 3])
}

Expand All @@ -1148,66 +1148,66 @@ mod tests {
bimap.insert('b', 2);
bimap.insert('c', 1);

let mut iter = bimap.right_values();
let mut iter = bimap.values_right();
assert_eq!(iter.next_back(), Some(&3));
assert_eq!(iter.next_back(), Some(&2));
assert_eq!(iter.next_back(), Some(&1));
}

#[test]
fn left_range() {
fn range_left() {
let mut bimap = BiBTreeMap::new();
bimap.insert('a', 4);
bimap.insert('b', 3);
bimap.insert('c', 2);
bimap.insert('d', 1);
let left_range = bimap
.left_range('b'..'d')
let range_left = bimap
.range_left('b'..'d')
.map(|(l, r)| (*l, *r))
.collect::<Vec<_>>();
assert_eq!(left_range, vec![('b', 3), ('c', 2)])
assert_eq!(range_left, vec![('b', 3), ('c', 2)])
}

#[test]
fn left_range_rev() {
fn range_left_rev() {
let mut bimap = BiBTreeMap::new();
bimap.insert('a', 4);
bimap.insert('b', 3);
bimap.insert('c', 2);
bimap.insert('d', 1);
let mut left_range = bimap.left_range('b'..'d');
let mut range_left = bimap.range_left('b'..'d');

assert_eq!(left_range.next_back(), Some((&'c', &2)));
assert_eq!(left_range.next_back(), Some((&'b', &3)));
assert_eq!(left_range.next_back(), None);
assert_eq!(range_left.next_back(), Some((&'c', &2)));
assert_eq!(range_left.next_back(), Some((&'b', &3)));
assert_eq!(range_left.next_back(), None);
}

#[test]
fn right_range() {
fn range_right() {
let mut bimap = BiBTreeMap::new();
bimap.insert('a', 4);
bimap.insert('b', 3);
bimap.insert('c', 2);
bimap.insert('d', 1);
let right_range = bimap
.right_range(2..4)
let range_right = bimap
.range_right(2..4)
.map(|(l, r)| (*l, *r))
.collect::<Vec<_>>();
assert_eq!(right_range, vec![('c', 2), ('b', 3)])
assert_eq!(range_right, vec![('c', 2), ('b', 3)])
}

#[test]
fn right_range_rev() {
fn range_right_rev() {
let mut bimap = BiBTreeMap::new();
bimap.insert('a', 4);
bimap.insert('b', 3);
bimap.insert('c', 2);
bimap.insert('d', 1);
let mut right_range = bimap.right_range(2..4);
let mut range_right = bimap.range_right(2..4);

assert_eq!(right_range.next_back(), Some((&'b', &3)));
assert_eq!(right_range.next_back(), Some((&'c', &2)));
assert_eq!(right_range.next_back(), None);
assert_eq!(range_right.next_back(), Some((&'b', &3)));
assert_eq!(range_right.next_back(), Some((&'c', &2)));
assert_eq!(range_right.next_back(), None);
}

#[test]
Expand Down
32 changes: 16 additions & 16 deletions src/hash.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,11 +177,11 @@ where
/// bimap.insert('b', 2);
/// bimap.insert('c', 3);
///
/// for char_value in bimap.left_values() {
/// for char_value in bimap.values_left() {
/// println!("{}", char_value);
/// }
/// ```
pub fn left_values(&self) -> LeftValues<'_, L, R> {
pub fn values_left(&self) -> LeftValues<'_, L, R> {
LeftValues {
inner: self.left2right.iter(),
}
Expand All @@ -202,11 +202,11 @@ where
/// bimap.insert('b', 2);
/// bimap.insert('c', 3);
///
/// for int_value in bimap.right_values() {
/// for int_value in bimap.values_right() {
/// println!("{}", int_value);
/// }
/// ```
pub fn right_values(&self) -> RightValues<'_, L, R> {
pub fn values_right(&self) -> RightValues<'_, L, R> {
RightValues {
inner: self.right2left.iter(),
}
Expand Down Expand Up @@ -856,9 +856,9 @@ impl<'a, L, R> Iterator for Iter<'a, L, R> {

/// An iterator over the left values in a `BiHashMap`.
///
/// This struct is created by the [`left_values`] method of `BiHashMap`.
/// This struct is created by the [`values_left`] method of `BiHashMap`.
///
/// [`left_values`]: BiHashMap::left_values
/// [`values_left`]: BiHashMap::values_left
#[derive(Debug, Clone)]
pub struct LeftValues<'a, L, R> {
inner: hash_map::Iter<'a, Ref<L>, Ref<R>>,
Expand All @@ -882,9 +882,9 @@ impl<'a, L, R> Iterator for LeftValues<'a, L, R> {

/// An iterator over the right values in a `BiHashMap`.
///
/// This struct is created by the [`right_values`] method of `BiHashMap`.
/// This struct is created by the [`values_right`] method of `BiHashMap`.
///
/// [`right_values`]: BiHashMap::right_values
/// [`values_right`]: BiHashMap::values_right
#[derive(Debug, Clone)]
pub struct RightValues<'a, L, R> {
inner: hash_map::Iter<'a, Ref<R>, Ref<L>>,
Expand Down Expand Up @@ -1054,25 +1054,25 @@ mod tests {
}

#[test]
fn left_values() {
fn values_left() {
let mut bimap = BiHashMap::new();
bimap.insert('a', 3);
bimap.insert('b', 2);
bimap.insert('c', 1);
let mut left_values = bimap.left_values().cloned().collect::<Vec<_>>();
left_values.sort();
assert_eq!(left_values, vec!['a', 'b', 'c'])
let mut values_left = bimap.values_left().cloned().collect::<Vec<_>>();
values_left.sort();
assert_eq!(values_left, vec!['a', 'b', 'c'])
}

#[test]
fn right_values() {
fn values_right() {
let mut bimap = BiHashMap::new();
bimap.insert('a', 3);
bimap.insert('b', 2);
bimap.insert('c', 1);
let mut right_values = bimap.right_values().cloned().collect::<Vec<_>>();
right_values.sort();
assert_eq!(right_values, vec![1, 2, 3])
let mut values_right = bimap.values_right().cloned().collect::<Vec<_>>();
values_right.sort();
assert_eq!(values_right, vec![1, 2, 3])
}

#[test]
Expand Down