alchemist/it.unibo.alchemist.model.cognitive.groups/Family

Family

class Family<T>(comparator: Comparator<Node<T>> = Comparator { a, b -> a.id.compareTo(b.id) }) : GenericGroup<T, Node<T>> , GroupWithLeader<T, Node<T>>

A Family is modeled as a group of pedestrians with a leader.

Constructors

constructor(comparator: Comparator<Node<T>> = Comparator { a, b -> a.id.compareTo(b.id) })

Properties

open override val leader: Node<T>

The leader of the group.

open val members: List<Node<T>>

The list of pedestrians belonging to this group.

open override val size: Int

Functions

open override fun add(element: Node<T>): Boolean

open override fun add(index: Int, element: Node<T>)

open override fun addAll(elements: Collection<Node<T>>): Boolean

open override fun addAll(index: Int, elements: Collection<Node<T>>): Boolean

fun addMember(node: Node<T>): Boolean

adds node to the group if not already added.

open override fun clear()

open operator override fun contains(element: Node<T>): Boolean

open override fun containsAll(elements: Collection<Node<T>>): Boolean

findExtremeCoordsOnX

fun <V : Vector2D<V>> List<V>.findExtremeCoordsOnX(): ClosedRange<Double>

Given a non-empty list of points represented as vectors, this method finds the extreme coordinates (i.e. min and max coordinates) on the X-axis, these are used to create the returned ClosedRange.

findExtremeCoordsOnY

fun <V : Vector2D<V>> List<V>.findExtremeCoordsOnY(): ClosedRange<Double>

Given a non-empty list of points represented as vectors, this method finds the extreme coordinates (i.e. min and max coordinates) on the Y-axis, these are used to create the returned ClosedRange.

open operator override fun get(index: Int): Node<T>

open override fun indexOf(element: Node<T>): Int

open override fun isEmpty(): Boolean

open operator override fun iterator(): MutableIterator<Node<T>>

open override fun lastIndexOf(element: Node<T>): Int

open override fun listIterator(): MutableListIterator<Node<T>>

open override fun listIterator(index: Int): MutableListIterator<Node<T>>

fun <R> Iterable<R>.randomElement(randomGenerator: RandomGenerator): R

Returns a random element of the Iterable using the provided randomGenerator.

open override fun remove(element: Node<T>): Boolean

open override fun removeAll(elements: Collection<Node<T>>): Boolean

open override fun removeAt(index: Int): Node<T>

fun removeMember(node: Node<T>): Boolean

removes, if present, node from the group.

open override fun retainAll(elements: Collection<Node<T>>): Boolean

open operator override fun set(index: Int, element: Node<T>): Node<T>

fun <R> Iterable<R>.shuffled(randomGenerator: RandomGenerator): Iterable<R>

Fisher–Yates shuffle algorithm using a RandomGenerator. More information on Wikipedia.

open override fun subList(fromIndex: Int, toIndex: Int): MutableList<Node<T>>

fun <T> List<T>.takeFraction(percentage: Double): List<T>

Takes the first percentage * size elements of the list.