Class Label<TimeVal, SI, RI, V, CA>

constructor

• new Label<TimeVal, SI extends Id, RI extends Id, V, CA extends [V, string][]>(
      timeType: Time<TimeVal>,
      criteria: {
          [K in string | number | symbol]: Criterion<
              TimeVal,
              SI,
              RI,
              CA[K<K>][0],
              CA[K<K>][1],
          >
      },
      time: TimeVal,
  ): Label<TimeVal, SI, RI, V, CA>

  Type Parameters

  • TimeVal
  • SI extends Id
  • RI extends Id
  • V
  • CA extends [V, string][]

  Parameters

  • timeType: Time<TimeVal>
  • criteria: {
        [K in string | number | symbol]: Criterion<
            TimeVal,
            SI,
            RI,
            CA[K<K>][0],
            CA[K<K>][1],
        >
    }
  • time: TimeVal

  Returns Label<TimeVal, SI, RI, V, CA>

Readonlycriteria

time

• get time(): TimeVal

  Returns TimeVal

compare

• compare(l: Label<TimeVal, SI, RI, V, CA>): null | 0 | 1 | -1

  Compares this label with another by checking criteria domination.

  Parameters

  • l: Label<TimeVal, SI, RI, V, CA>

    The label to be compared with

  Returns null | 0 | 1 | -1

  -1 if this label is dominated by l, 0 if they are equal, 1 otherwise

setValue

• setValue<C extends [V, string]>(
      criterionName: C[1],
      value: C[0],
  ): Label<TimeVal, SI, RI, V, CA>

  Change the value of one criterion

  Type Parameters

  • C extends [V, string]

  Parameters

  • criterionName: C[1]

    The criterion name to change its value
  • value: C[0]

    The new value to set

  Returns Label<TimeVal, SI, RI, V, CA>

  A copy of this label with the changed criterion value

update

• update(
      time: TimeVal,
      data: [
          prefixJourney: Journey<
              TimeVal,
              SI,
              RI,
              CA[number][0],
              [[CA[number][0], CA[number][1]]],
          >,
          newJourneyStep: Omit<
              JourneyStep<
                  TimeVal,
                  SI,
                  RI,
                  CA[number][0],
                  [[CA[number][0], CA[number][1]]],
                  LabelType,
                  false,
              >,
              "label" | "compare",
          >,
          timeType: Time<TimeVal>,
          time: TimeVal,
          stop: SI,
      ],
  ): Label<TimeVal, SI, RI, V, CA>

  Parameters

  • time: TimeVal
  • data: [
        prefixJourney: Journey<
            TimeVal,
            SI,
            RI,
            CA[number][0],
            [[CA[number][0], CA[number][1]]],
        >,
        newJourneyStep: Omit<
            JourneyStep<
                TimeVal,
                SI,
                RI,
                CA[number][0],
                [[CA[number][0], CA[number][1]]],
                LabelType,
                false,
            >,
            "label" | "compare",
        >,
        timeType: Time<TimeVal>,
        time: TimeVal,
        stop: SI,
    ]

  Returns Label<TimeVal, SI, RI, V, CA>

value

• value<C extends [V, string]>(criterionName: C[1]): C[0]

  Type Parameters

  • C extends [V, string]

  Parameters

  • criterionName: C[1]

  Returns C[0]