struct AVLTree::SortedMultiset(T)

Overview

SortedMultiset implements a collection of sorted values with possible duplicates.

Sample

require "avltree"

mset = AVLTree::SortedMultiset(Int32).new
mset << 3 << 1 << 4 << 1 << 5 << 9

mset # => SortedMultiset{1, 1, 3, 4, 5, 9}

mset[0] # => 1
mset[1] # => 1
mset[2] # => 3  (SortedMultiset#[k] returns the kth object)

mset.lower_bound(-1) # => 0
mset.lower_bound(2)  # => 2
mset.lower_bound(3)  # => 2
mset.lower_bound(9)  # => 5
mset.lower_bound(10) # => 6

mset.delete(1)
mset # => SortedMultiset{1, 3, 4, 5, 9}

Included Modules

Defined in:

avltree/sorted_multiset.cr

Constructors

Instance Method Summary

Instance methods inherited from module Enumerable(T)

to_sorted_multiset to_sorted_multiset, to_sorted_set to_sorted_set

Instance methods inherited from module Enumerable(T)

to_sorted_multiset to_sorted_multiset, to_sorted_set to_sorted_set

Constructor Detail

def self.new(other : Indexable(T)) #

[View source]
def self.new(enumerable : Enumerable(T)) #

[View source]
def self.new #

[View source]

Instance Method Detail

def &(other : SortedMultiset) #

[View source]
def +(other : SortedMultiset(U)) forall U #

[View source]
def -(other : SortedMultiset) #

[View source]
def -(other : Enumerable) #

[View source]
def <<(object : T) #

[View source]
def ==(other : SortedMultiset) #

[View source]
def ===(object : T) #

[View source]
def ^(other : SortedMultiset(U)) forall U #

[View source]
def ^(other : Enumerable(U)) forall U #

[View source]
def |(other : SortedMultiset(U)) forall U #

[View source]
def add(object : T) #

[View source]
def add?(object : T) #

[View source]
def at(index : Int) #

Returns the element at the index-th.


[View source]
def at(index : Int, &) #

Returns the element at the index-th.


[View source]
def at?(index : Int) #

Like #at, but returns nil if trying to access an element outside the multiset's range.


[View source]
def clear #

[View source]
def clone #

[View source]
def concat(elems) #

[View source]
def count(range : Range(T | Nil, T | Nil)) #

Returns the number of elements in the set that exist within the range

set = AVLTree::SortedSet(Int32){3, 1, 4, 1, 5, 9}
set.count(0..1).should eq 2
set.count(0...1).should eq 0
set.count(0..2).should eq 2
set.count(0...2).should eq 2
set.count(2..3).should eq 1
set.count(2...3).should eq 0
set.count(2..9).should eq 4
set.count(2...9).should eq 3
set.count(2...).should eq 4
set.count(...).should eq 6
set.count(...9).should eq 5

[View source]
def count(object) #
Description copied from module Enumerable(T)

Returns the number of times that the passed item is present in the collection.

[1, 2, 3, 4].count(3) # => 1

[View source]
def delete(object) #

[View source]
def delete_at(object) #

[View source]
def delete_at?(object) #

[View source]
def dup #
Description copied from struct Value

Returns a shallow copy of this object.

Because Value is a value type, this method returns self, which already involves a shallow copy of this object because value types are passed by value.


[View source]
def each(&) #
Description copied from module Indexable(T)

Calls the given block once for each element in self, passing that element as a parameter.

a = ["a", "b", "c"]
a.each { |x| print x, " -- " }

produces:

a -- b -- c --

[View source]
def each #
Description copied from module Iterable(T)

Must return an Iterator over the elements in this collection.


[View source]
def empty? #
Description copied from module Indexable(T)

Returns true if self is empty, false otherwise.

([] of Int32).empty? # => true
([1]).empty?         # => false

[View source]
def fetch(index : Int, &) #
Description copied from module Indexable(T)

Returns the element at the given index, if in bounds, otherwise executes the given block with the index and returns its value.

a = [:foo, :bar]
a.fetch(0) { :default_value }    # => :foo
a.fetch(2) { :default_value }    # => :default_value
a.fetch(2) { |index| index * 3 } # => 6

[View source]
def fetch(index : Int, default) #

[View source]
def first #
Description copied from module Enumerable(T)

Returns the first element in the collection. Raises Enumerable::EmptyError if the collection is empty.

([1, 2, 3]).first   # => 1
([] of Int32).first # raises Enumerable::EmptyError

[View source]
def first? #
Description copied from module Enumerable(T)

Returns the first element in the collection. When the collection is empty, returns nil.

([1, 2, 3]).first?   # => 1
([] of Int32).first? # => nil

[View source]
def greater_equal_index(object) : Int32 | Nil #

[View source]
def greater_equal_object(object) : T | Nil #

[View source]
def greater_equal_object_with_index(object) : Tuple(T | Nil, Int32 | Nil) #

[View source]
def greater_index(object) : Int32 | Nil #

[View source]
def greater_object(object) : T | Nil #

[View source]
def greater_object_with_index(object) : Tuple(T | Nil, Int32 | Nil) #

[View source]
def hash(hasher) #
Description copied from module Indexable(T)

See Object#hash(hasher)


[View source]
def includes?(object) #
Description copied from module Enumerable(T)

Returns true if the collection contains obj, false otherwise.

[1, 2, 3].includes?(2) # => true
[1, 2, 3].includes?(5) # => false

[View source]
def index(object) #
Description copied from module Indexable(T)

Returns the index of the first appearance of object in self starting from the given offset, or nil if object is not in self.

[1, 2, 3, 1, 2, 3].index(2, offset: 2) # => 4

[View source]
def index!(object) #
Description copied from module Indexable(T)

Returns the index of the first appearance of obj in self starting from the given offset. Raises Enumerable::NotFoundError if obj is not in self.

[1, 2, 3, 1, 2, 3].index!(2, offset: 2) # => 4

[View source]
def inspect(io : IO) : Nil #
Description copied from struct Struct

Appends this struct's name and instance variables names and values to the given IO.

struct Point
  def initialize(@x : Int32, @y : Int32)
  end
end

p1 = Point.new 1, 2
p1.to_s    # "Point(@x=1, @y=2)"
p1.inspect # "Point(@x=1, @y=2)"

[View source]
def intersects?(other : SortedMultiset) #

[View source]
def last #
Description copied from module Indexable(T)

Returns the last element of self if it's not empty, or raises IndexError.

([1, 2, 3]).last   # => 3
([] of Int32).last # raises IndexError

[View source]
def last? #
Description copied from module Indexable(T)

Returns the last element of self if it's not empty, or nil.

([1, 2, 3]).last?   # => 3
([] of Int32).last? # => nil

[View source]
def less_equal_index(object) : Int32 | Nil #

[View source]
def less_equal_object(object) : T | Nil #

[View source]
def less_equal_object_with_index(object) : Tuple(T | Nil, Int32 | Nil) #

[View source]
def less_index(object) : Int32 | Nil #

[View source]
def less_object(object) : T | Nil #

[View source]
def less_object_with_index(object) : Tuple(T | Nil, Int32 | Nil) #

[View source]
def lower_bound(object) : Int32 #

[View source]
def max #
Description copied from module Enumerable(T)

Returns the element with the maximum value in the collection.

It compares using > so it will work for any type that supports that method.

[1, 2, 3].max        # => 3
["Alice", "Bob"].max # => "Bob"

Raises Enumerable::EmptyError if the collection is empty.


[View source]
def max? #
Description copied from module Enumerable(T)

Like #max but returns nil if the collection is empty.


[View source]
def min #
Description copied from module Enumerable(T)

Returns the element with the minimum value in the collection.

It compares using < so it will work for any type that supports that method.

[1, 2, 3].min        # => 1
["Alice", "Bob"].min # => "Alice"

Raises Enumerable::EmptyError if the collection is empty.


[View source]
def min? #
Description copied from module Enumerable(T)

Like #min but returns nil if the collection is empty.


[View source]
def object_id #

[View source]
def pop : T #

[View source]
def pop(&) #

[View source]
def pop? : T | Nil #

[View source]
def pretty_print(pp) : Nil #

[View source]
def proper_subset_of?(other : SortedMultiset) #

[View source]
def proper_superset?(other : SortedMultiset) #

[View source]
def rindex(object) #
Description copied from module Indexable(T)

Returns the index of the last appearance of value in self, or nil if the value is not in self.

If offset is given, it defines the position to end the search (elements beyond this point are ignored).

[1, 2, 3, 2, 3].rindex(2)            # => 3
[1, 2, 3, 2, 3].rindex(2, offset: 2) # => 1

[View source]
def rindex!(object) #
Description copied from module Indexable(T)

Returns the index of the last appearance of value in self, or nil if the value is not in self.

If offset is given, it defines the position to end the search (elements beyond this point are ignored).

[1, 2, 3, 2, 3].rindex(2)            # => 3
[1, 2, 3, 2, 3].rindex(2, offset: 2) # => 1

Raises Enumerable::NotFoundError if value is not in self.


[View source]
def same?(other : SortedMultiset) #

[View source]
def shift : T #

[View source]
def shift(&) #

[View source]
def shift? : T | Nil #

[View source]
def size #
Description copied from module Indexable(T)

Returns the number of elements in this container.


[View source]
def subset_of?(other : SortedMultiset) #

[View source]
def subtract(other : Enumerable) #

[View source]
def superset_of?(other : SortedMultiset) #

[View source]
def to_a #
Description copied from module Indexable(T)

Returns an Array with all the elements in the collection.

{1, 2, 3}.to_a # => [1, 2, 3]

[View source]
def to_s(io : IO) : Nil #
Description copied from struct Struct

Same as #inspect(io).


[View source]
def unordered_each(&) #

[View source]
def unsafe_fetch(index : Int) #
Description copied from module Indexable(T)

Returns the element at the given index, without doing any bounds check.

Indexable makes sure to invoke this method with index in 0...size, so converting negative indices to positive ones is not needed here.

Clients never invoke this method directly. Instead, they access elements with #[](index) and #[]?(index).

This method should only be directly invoked if you are absolutely sure the index is in bounds, to avoid a bounds check for a small boost of performance.


[View source]
def upper_bound(object) : Int32 #

[View source]