collektivize/it.unibo.collektive.aggregate.api

Package-level declarations

Types

Models the minimal set of aggregate operations. Holds the localId of the device executing the aggregate program.

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS, AnnotationTarget.FILE])

annotation class CollektiveIgnore(val explanation: String)

Indicates that a function, class, or file should not be automatically instrumented with alignment behavior by the Collektive compiler plugin.

DataSharingMethod

sealed interface DataSharingMethod<in DataType>

A method to share data between nodes in a network.

DelicateCollektiveApi

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CLASS])

annotation class DelicateCollektiveApi

Represents methods intended to be used internally only. The usage of these methods is discouraged and should be avoided.

InMemory

data object InMemory : DataSharingMethod<Any?>

In-memory share. No serialization. Working only across multiple nodes hosted on the same operating system (for instance, in simulation).

Serialize

@JvmInline

value class Serialize<DataType>(val serializer: KSerializer<DataType>) : DataSharingMethod<DataType>

Serialization-based share using kotlinx.serialization. The data is serialized and deserialized using the provided serializer.

YieldingContext

class YieldingContext<Shared, Returned>

Context for yielding operations (exchanging, sharing). Yielding operations operate on a Shared value (usually exchanged with neighbors), but return a differently typed value Returned to the caller.

YieldingResult

data class YieldingResult<Shared, Return>(val toSend: Shared, val toReturn: Return)

Specifies the value toSend and the value toReturn of a yielding operator.

YieldingScope

typealias YieldingScope<Shared, Returned> = YieldingContext<Shared, Returned>.(Shared) -> YieldingResult<Shared, Returned>