mirror of https://github.com/emirpasic/gods
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
84 lines
4.3 KiB
Go
84 lines
4.3 KiB
Go
/*
|
|
Copyright (c) 2015, Emir Pasic
|
|
All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are met:
|
|
|
|
* Redistributions of source code must retain the above copyright notice, this
|
|
list of conditions and the following disclaimer.
|
|
|
|
* Redistributions in binary form must reproduce the above copyright notice,
|
|
this list of conditions and the following disclaimer in the documentation
|
|
and/or other materials provided with the distribution.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
package containers
|
|
|
|
// EnumerableWithIndex provides functions for ordered containers whose values can be fetched by an index.
|
|
type EnumerableWithIndex interface {
|
|
// Each calls the given function once for each element, passing that element's index and value.
|
|
Each(func(index int, value interface{}))
|
|
|
|
// Map invokes the given function once for each element and returns a
|
|
// container containing the values returned by the given function.
|
|
// TODO need help on how to enforce this in containers (don't want to type assert when chaining)
|
|
// Map(func(index int, value interface{}) interface{}) Container
|
|
|
|
// Select returns a new container containing all elements for which the given function returns a true value.
|
|
// TODO need help on how to enforce this in containers (don't want to type assert when chaining)
|
|
// Select(func(index int, value interface{}) bool) Container
|
|
|
|
// Any passes each element of the container to the given function and
|
|
// returns true if the function ever returns true for any element.
|
|
Any(func(index int, value interface{}) bool) bool
|
|
|
|
// All passes each element of the container to the given function and
|
|
// returns true if the function returns true for all elements.
|
|
All(func(index int, value interface{}) bool) bool
|
|
|
|
// Find passes each element of the container to the given function and returns
|
|
// the first (index,value) for which the function is true or -1,nil otherwise
|
|
// if no element matches the criteria.
|
|
Find(func(index int, value interface{}) bool) (int, interface{})
|
|
}
|
|
|
|
// EnumerableWithKey provides functions for ordered containers whose values whose elements are key/value pairs.
|
|
type EnumerableWithKey interface {
|
|
// Each calls the given function once for each element, passing that element's key and value.
|
|
Each(func(key interface{}, value interface{}))
|
|
|
|
// Map invokes the given function once for each element and returns a container
|
|
// containing the values returned by the given function as key/value pairs.
|
|
// TODO need help on how to enforce this in containers (don't want to type assert when chaining)
|
|
// Map(func(key interface{}, value interface{}) (interface{}, interface{})) Container
|
|
|
|
// Select returns a new container containing all elements for which the given function returns a true value.
|
|
// TODO need help on how to enforce this in containers (don't want to type assert when chaining)
|
|
// Select(func(key interface{}, value interface{}) bool) Container
|
|
|
|
// Any passes each element of the container to the given function and
|
|
// returns true if the function ever returns true for any element.
|
|
Any(func(key interface{}, value interface{}) bool) bool
|
|
|
|
// All passes each element of the container to the given function and
|
|
// returns true if the function returns true for all elements.
|
|
All(func(key interface{}, value interface{}) bool) bool
|
|
|
|
// Find passes each element of the container to the given function and returns
|
|
// the first (key,value) for which the function is true or nil,nil otherwise if no element
|
|
// matches the criteria.
|
|
Find(func(key interface{}, value interface{}) bool) (interface{}, interface{})
|
|
}
|