Skip to content

KernelAPI reference

Class StepHash

Namespace: MicroEngine.Kernel
Assembly: MicroEngine.Kernel.dll
Guide: Modules and the frame schedule

The state hash after one fixed step.

C#
public sealed record StepHash : IEquatable<StepHash>

Inheritance

object ← StepHash

Implements

IEquatable<StepHash>

Constructors

StepHash(long, ulong, IReadOnlyList<SectionHash>)

The state hash after one fixed step.

C#
public StepHash(long Update, ulong Hash, IReadOnlyList<SectionHash> Sections)

Parameters

Update long

The update the step ended (1 for the first).

Hash ulong

The hash of the whole state.

Sections IReadOnlyList<SectionHash>

The hash of each section, in order; empty unless the trace asked for them (Sections).

Properties

Hash

The hash of the whole state.

C#
public ulong Hash { get; init; }

Property Value

ulong

Sections

The hash of each section, in order; empty unless the trace asked for them (Sections).

C#
public IReadOnlyList<SectionHash> Sections { get; init; }

Property Value

IReadOnlyList<SectionHash>

Update

The update the step ended (1 for the first).

C#
public long Update { get; init; }

Property Value

long

Methods

<Clone>$()

C#
public StepHash <Clone>$()

Returns

StepHash

Deconstruct(out long, out ulong, out IReadOnlyList<SectionHash>)

C#
public void Deconstruct(out long Update, out ulong Hash, out IReadOnlyList<SectionHash> Sections)

Parameters

Update long

Hash ulong

Sections IReadOnlyList<SectionHash>

Equals(object?)

C#
public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(StepHash?)

C#
public bool Equals(StepHash? other)

Parameters

other StepHash?

Returns

bool

GetHashCode()

C#
public override int GetHashCode()

Returns

int

ToString()

C#
public override string ToString()

Returns

string

Operators

operator ==(StepHash?, StepHash?)

C#
public static bool operator ==(StepHash? left, StepHash? right)

Parameters

left StepHash?

right StepHash?

Returns

bool

operator !=(StepHash?, StepHash?)

C#
public static bool operator !=(StepHash? left, StepHash? right)

Parameters

left StepHash?

right StepHash?

Returns

bool