Module aya.base
Package org.aya.terck

Interface Relation

All Superinterfaces:
org.aya.pretty.doc.Docile, Selector.Candidate<Relation>
All Known Implementing Classes:
Relation.Decrease, Relation.Unknown
public sealed interface Relation extends org.aya.pretty.doc.Docile, Selector.Candidate<Relation> permits Relation.Unknown, Relation.Decrease
Relations between size of formal function parameter and function argument in one recursive call. A semi-ring with zero = unk(), one = eq().

  • Method Details

    • toDoc

      @NotNull default @NotNull org.aya.pretty.doc.Doc toDoc()
      Specified by:
      toDoc in interface org.aya.pretty.doc.Docile

    • mul

      @Contract(pure=true) @NotNull default @NotNull Relation mul(@NotNull @NotNull Relation rhs)

    • add

      @Contract(pure=true) @NotNull default @NotNull Relation add(@NotNull @NotNull Relation rhs)
      Returns:
      the side that decreases more

    • compare

      @NotNull default Selector.DecrOrd compare(@NotNull @NotNull Relation other)
      Compare two relations by their decrease amount.
      Specified by:
      compare in interface Selector.Candidate<Relation>
      Returns:
      Selector.DecrOrd.Lt if this decreases less than the other, Selector.DecrOrd.Gt if this decreases more.

    • isUnknown

      default boolean isUnknown()

    • isDecreasing

      default boolean isDecreasing()

    • fromCompare

      @NotNull static @NotNull Relation fromCompare(int compare)

    • decr

      @NotNull static @NotNull Relation decr(boolean usable, int size)

    • eq

      @NotNull static @NotNull Relation eq()

    • lt

      @NotNull static @NotNull Relation lt()

    • unk

      @NotNull static @NotNull Relation unk()