Class BinaryOperatorAggregate<ValueType, UpdateType>

constructor

• new BinaryOperatorAggregate<ValueType, UpdateType = ValueType>(
      operator: BinaryOperator<ValueType, UpdateType>,
      initialValueFactory?: () => ValueType,
  ): BinaryOperatorAggregate<ValueType, UpdateType>

  Type Parameters

  • ValueType
  • UpdateType = ValueType

  Parameters

  • operator: BinaryOperator<ValueType, UpdateType>
  • OptionalinitialValueFactory: () => ValueType

  Returns BinaryOperatorAggregate<ValueType, UpdateType>

OptionalinitialValueFactory

lc_graph_name

operator

value

checkpoint

• checkpoint(): ValueType

  Return a string representation of the channel's current state.

  Returns ValueType

  Throws

  if the channel is empty (never updated yet), or doesn't support checkpoints.

fromCheckpoint

• fromCheckpoint(checkpoint?: ValueType): this

  Return a new identical channel, optionally initialized from a checkpoint. Can be thought of as a "restoration" from a checkpoint which is a "snapshot" of the channel's state.

  Parameters

  • Optionalcheckpoint: ValueType

  Returns this

get

• get(): ValueType

  Return the current value of the channel.

  Returns ValueType

  Throws

  if the channel is empty (never updated yet).

update

• update(values: UpdateType[]): boolean

  Update the channel's value with the given sequence of updates. The order of the updates in the sequence is arbitrary. This method is called by Pregel for all channels at the end of each step. If there are no updates, it is called with an empty sequence.

  Raises InvalidUpdateError if the sequence of updates is invalid. Returns True if the channel was updated, False otherwise.

  Parameters

  • values: UpdateType[]

  Returns boolean

  Throws

  if the sequence of updates is invalid.