kone.collections/dev.lounres.kone.collections.searchTree/SearchSegmentResult

SearchSegmentResult

sealed interface SearchSegmentResult<out SearchTreeNode>(source)

Represents a result of search for specified priority in a search tree. There are exactly five possible outcomes of the operation:

The search tree is empty. In that case, the Empty object is returned.
The priority coincides with some node's priority. In that case, the Coincidence instance with the node is returned.
The priority is strictly less than the minimal priority. In that case, the LessThanMinimum instance with the minimal noded is returned.
The priority is strictly greater than the maximal priority. In that case, the GreaterThanMaximum instance with the maximal noded is returned.
The priority lies strictly between priorities of two neighbour nodes. In that case the Between instance with the lowerBound and upperBound nodes is returned.

Inheritors

Types

Between

data class Between<out SearchTreeNode>(val lowerBound: SearchTreeNode, val upperBound: SearchTreeNode) : SearchSegmentResult<SearchTreeNode>

Represents a case when the priority lies strictly between priorities of two neighbour nodes. In that case the class's instance with the lowerBound and upperBound nodes is returned.

Coincidence

data class Coincidence<out SearchTreeNode>(val value: SearchTreeNode) : SearchSegmentResult<SearchTreeNode>

Represents a case when the priority coincides with some node's priority. In that case, the class's instance with the node is returned.

Empty

data object Empty : SearchSegmentResult<Nothing>

Represents a case when the search tree is empty. In that case, the object is returned.

GreaterThanMaximum

data class GreaterThanMaximum<out SearchTreeNode>(val maximum: SearchTreeNode) : SearchSegmentResult<SearchTreeNode>

Represents a case when the priority is strictly greater than the maximal priority. In that case, the class's instance with the maximal noded is returned.

LessThanMinimum

data class LessThanMinimum<out SearchTreeNode>(val minimum: SearchTreeNode) : SearchSegmentResult<SearchTreeNode>

Represents a case when the priority is strictly less than the minimal priority. In that case, the class's instance with the minimal noded is returned.