dsl/it.unibo.collektive.field.operations

Package-level declarations

Functions

inline fun <ID : Any, T> Field<ID, T>.all(crossinline predicate: (T) -> Boolean): Boolean

Check if all the elements in the field satisfy the predicate, ignoring the local value.

fun <ID : Any> Field<ID, Boolean>.all(base: Boolean, predicate: (Boolean) -> Boolean = { it }): Boolean

Check if all the Boolean elements in the field are true by default. If predicate is defined, it is applied to the elements. The base value is used as a first element to start the fold operation at which the predicate is applied.

allWithSelf

inline fun <ID : Any, T> Field<ID, T>.allWithSelf(crossinline predicate: (T) -> Boolean): Boolean

Check if all the elements in the field satisfy the predicate, including the local value.

any

inline fun <ID : Any, T> Field<ID, T>.any(crossinline predicate: (T) -> Boolean): Boolean

Check if any of the elements in the field satisfy the predicate, ignoring the local value.

@JvmOverloads

fun <ID : Any> Field<ID, Boolean>.any(base: Boolean, predicate: (Boolean) -> Boolean = { it }): Boolean

Check if any of the Boolean elements in the field are true by default. If predicate is defined, it is applied to the elements. The base value is used as a first element to start the fold operation at which the predicate is applied.

anyWithSelf

inline fun <ID : Any, T> Field<ID, T>.anyWithSelf(crossinline predicate: (T) -> Boolean): Boolean

Check if any of the elements in the field satisfy the predicate, including the local value.

collect

@JvmOverloads

inline fun <ID : Any, T> Field<ID, T>.collect(crossinline predicate: (ID, T) -> Boolean = { _, _ -> true }): List<T>

Returns the list of field elements that satisfy the predicate. ignoring the local value.

inline fun <ID : Any, T, R> Field<ID, T>.collect(crossinline predicate: (ID, T) -> Boolean = { _, _ -> true }, crossinline transform: (ID, T) -> R): List<R>

Returns the list of field elements that satisfy the predicate, transformed using the transform function. ignoring the local value.

collectDistinct

@JvmOverloads

inline fun <ID : Any, T> Field<ID, T>.collectDistinct(crossinline predicate: (ID, T) -> Boolean = { _, _ -> true }): Set<T>

Returns the Set of field elements that satisfy the predicate, ignoring the local value.

inline fun <ID : Any, T, R> Field<ID, T>.collectDistinct(crossinline predicate: (ID, T) -> Boolean = { _, _ -> true }, crossinline transform: (ID, T) -> R): Set<R>

Returns the Set of field elements that satisfy the predicate, transformed using the transform function. ignoring the local value.

collectDistinctWithSelf

@JvmOverloads

inline fun <ID : Any, T> Field<ID, T>.collectDistinctWithSelf(crossinline predicate: (ID, T) -> Boolean = { _, _ -> true }): Set<T>

Returns the Set of field elements that satisfy the predicate, ignoring the local value.

inline fun <ID : Any, T, R> Field<ID, T>.collectDistinctWithSelf(crossinline predicate: (ID, T) -> Boolean = { _, _ -> true }, crossinline transform: (ID, T) -> R): Set<R>

Returns the Set of field elements that satisfy the predicate, transformed using the transform function. ignoring the local value.

collectIDs

@JvmOverloads

inline fun <ID : Any, T> Field<ID, T>.collectIDs(crossinline predicate: (ID, T) -> Boolean = { _, _ -> true }): Set<ID>

Returns the Set of neighbor IDs whose field entries satisfy the predicate. ignoring the local value.

collectIDsWithSelf

@JvmOverloads

inline fun <ID : Any, T> Field<ID, T>.collectIDsWithSelf(crossinline predicate: (ID, T) -> Boolean = { _, _ -> true }): Set<ID>

Returns the Set of neighbor IDs whose field entries satisfy the predicate. ignoring the local value.

collectWithSelf

@JvmOverloads

inline fun <ID : Any, T> Field<ID, T>.collectWithSelf(crossinline predicate: (ID, T) -> Boolean = { _, _ -> true }): List<T>

Returns the list of field elements that satisfy the predicate. including the local value.

inline fun <ID : Any, T, R> Field<ID, T>.collectWithSelf(crossinline predicate: (ID, T) -> Boolean = { _, _ -> true }, crossinline transform: (ID, T) -> R): List<R>

Returns the list of field elements that satisfy the predicate, transformed using the transform function. including the local value.

contains

operator fun <ID : Any, T> Field<ID, T>.contains(value: T): Boolean

Check if the field contains the value, including the local value. If you need to exclude the local value, use instead:

containsId

fun <ID : Any, T> Field<ID, T>.containsId(targetId: ID): Boolean

Check if the field contains the targetId, including the local id. If you need to exclude the local value, use instead:

count

@JvmOverloads

inline fun <ID : Any, T> Field<ID, T>.count(crossinline predicate: (T) -> Boolean = { true }): Int

Count the number of elements in the field that satisfy the predicate, ignoring the local value.

countWithSelf

@JvmOverloads

inline fun <ID : Any, T> Field<ID, T>.countWithSelf(crossinline predicate: (T) -> Boolean = { true }): Int

Count the number of elements in the field that satisfy the predicate, including the local value.

max

fun <ID : Any, T : Comparable<T>> Field<ID, T>.max(base: T): T

Get the maximum value of a field, excluding the local value, starting from base. To consider the local value, explicitly provide it as base.

maxBy

inline fun <ID : Any, T, R : Comparable<R>> Field<ID, T>.maxBy(base: T, crossinline selector: (T) -> R): T

Returns the element yielding the largest value of the given selector. In case multiple elements are maximal, there is no guarantee which one will be returned.

maxWith

fun <ID : Any, T> Field<ID, T>.maxWith(base: T, comparator: Comparator<T>): T

Returns the element yielding the largest value of the given comparator. In case multiple elements are maximal, there is no guarantee which one will be returned.

maxWithSelf

fun <ID : Any, T : Comparable<T>> Field<ID, T>.maxWithSelf(): T

Get the maximum value of a field, including the local value.

min

fun <ID : Any, T : Comparable<T>> Field<ID, T>.min(base: T): T

Get the minimum value of a field, excluding the local value, starting from base. To consider the local value, explicitly provide it as base.

minBy

inline fun <ID : Any, T, R : Comparable<R>> Field<ID, T>.minBy(base: T, crossinline selector: (T) -> R): T

Returns the element yielding the smallest value of the given selector. In case multiple elements are minimal, there is no guarantee which one will be returned.

minWith

fun <ID : Any, T> Field<ID, T>.minWith(base: T, comparator: Comparator<T>): T

Returns the element yielding the smallest value of the given comparator. In case multiple elements are minimal, there is no guarantee which one will be returned.

minWithId

fun <ID : Any, T> Field<ID, T>.minWithId(base: Pair<ID, T>, comparator: Comparator<Pair<ID, T>>): Pair<ID, T>

Returns the element yielding the smallest value of the given comparator. In case multiple elements are minimal, there is no guarantee which one will be returned.

minWithSelf

fun <ID : Any, T : Comparable<T>> Field<ID, T>.minWithSelf(): T

Get the minimum value of a field, including the local value.

none

inline fun <ID : Any, T> Field<ID, T>.none(crossinline predicate: (T) -> Boolean): Boolean

Check if none of the elements in the field satisfy the predicate, ignoring the local value.

@JvmOverloads

fun <ID : Any> Field<ID, Boolean>.none(base: Boolean, predicate: (Boolean) -> Boolean = { it }): Boolean

Check if none of the Boolean elements in the field are true by default. If predicate is defined, it is applied to the elements. The base value is used as a first element to start the fold operation at which the predicate is applied.

noneWithSelf

inline fun <ID : Any, T> Field<ID, T>.noneWithSelf(crossinline predicate: (T) -> Boolean): Boolean

Check if none of the elements in the field satisfy the predicate, including the local value.

replaceMatching

inline fun <ID : Any, T> Field<ID, T>.replaceMatching(replaceWith: T, crossinline predicate: (T) -> Boolean): Field<ID, T>

Returns a new field containing replaceWith for each element that satisfies the predicate.

replaceMatchingWithId

inline fun <ID : Any, T> Field<ID, T>.replaceMatchingWithId(replaceWith: T, crossinline predicate: (ID, T) -> Boolean): Field<ID, T>

Returns a new field containing replaceWith for each element that satisfies the predicate.