Class McRAPTOR<TimeVal, V, CA, SI, RI, TI>

Type Parameters

TimeVal
V extends Ordered<V>
CA extends [V, string][]
SI extends Id = Id
RI extends Id = Id
TI extends Id = Id

Hierarchy (View Summary)

default<TimeVal, SI, RI, TI, V, CA>
- McRAPTOR
  - McSharedRAPTOR

Index

Constructors

constructor

new McRAPTOR<
    TimeVal,
    V extends Ordered<V>,
    CA extends [V, string][],
    SI extends Id = Id,
    RI extends Id = Id,
    TI extends Id = Id,
>(
    data: IRAPTORData<TimeVal, SI, RI, TI>,
    criteria: {
        [K in string | number | symbol]: Criterion<
            TimeVal,
            SI,
            RI,
            CA[K<K>][0],
            CA[K<K>][1],
        >
    },
): McRAPTOR<TimeVal, V, CA, SI, RI, TI>
Type Parameters
- TimeVal
- V extends Ordered<V>
- CA extends [V, string][]
- SI extends Id = Id
- RI extends Id = Id
- TI extends Id = Id
Parameters
- data: IRAPTORData<TimeVal, SI, RI, TI>
- criteria: {
      [K in string | number | symbol]: Criterion<
          TimeVal,
          SI,
          RI,
          CA[K<K>][0],
          CA[K<K>][1],
      >
  }
Returns McRAPTOR<TimeVal, V, CA, SI, RI, TI>
Description
Creates a new McRAPTOR instance for a defined network and a set of criteria.
Overrides BaseRAPTOR<TimeVal, SI, RI, TI, V, CA>.constructor
- Defined in src/McRAPTOR.ts:22

Properties

`Protected`bags

bags: Map<SI, Bag<JourneyStep<TimeVal, SI, RI, V, CA>>>[] = []

Description

A Label Bags_i(SI) stores earliest known arrival times and best values for criteria at stop SI with up to i trips.

`Protected`Bpt

Bpt: null | Bag<JourneyStep<TimeVal, SI, RI, V, CA>> = null

`Protected` `Readonly`criteria

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

`Protected` `Readonly`data

data: IRAPTORData<TimeVal, SI, RI, TI>

`Protected`k

k: number = 0

Round k <=> at most k transfers

`Protected`marked

marked: Set<SI> = ...

`Protected`runParams

runParams:
    | null
    | {
        departureTime: TimeVal;
        ps: SI;
        pt: SI;
        rounds: number;
        settings: RAPTORRunSettings;
    } = null

`Static`defaultRounds

defaultRounds: number = 6

Accessors

routes

get routes(): MapRead<RI, Route<TimeVal, SI, RI, TI>>
Getter on routes from data

Returns MapRead<RI, Route<TimeVal, SI, RI, TI>>
Inherited from BaseRAPTOR.routes
- Defined in src/base.ts:46

stops

get stops(): MapRead<SI, Stop<SI, RI>>
Getter on stops from data

Returns MapRead<SI, Stop<SI, RI>>
Inherited from BaseRAPTOR.stops
- Defined in src/base.ts:39

time

get time(): Time<TimeVal>
Returns Time<TimeVal>
Inherited from BaseRAPTOR.time
- Defined in src/base.ts:50

Methods

`Protected`beginRound

beginRound(): void
Returns void
Overrides BaseRAPTOR.beginRound
- Defined in src/McRAPTOR.ts:94

`Protected`et

et(
    route: Route<TimeVal, SI, RI>,
    p: SI,
    after: TimeVal,
    startTripIndex?: number,
): null | { boardedAt: SI; tripIndex: number }
Parameters
- route: Route<TimeVal, SI, RI>
- p: SI
  Stop Id.
- after: TimeVal
  Time after which trips should be considered
- startTripIndex: number = 0
  Trip index to start iterating from
Returns null | { boardedAt: SI; tripIndex: number }
The earliest Trip on the route (and its index) r at the stop p, or null if no one is catchable.

Description
Finds the earliest Trip on route r at stop p departing after after.
Inherited from BaseRAPTOR.et
- Defined in src/base.ts:71

`Protected`forEachNDEt

forEachNDEt(
    route: Route<TimeVal, SI, RI, TI>,
    stop: SI,
    stopIndex: number,
    fromJourneyStep: JourneyStep<TimeVal, SI, RI, V, CA>,
    cb: (
        newJourneyStep: JourneyStep<TimeVal, SI, RI, V, CA, "VEHICLE">,
    ) => void,
): void
Scans earliest catchable trips after taking step fromJourneyStep, on route route at stop stop (stopIndex), and executes a callback cb.
Parameters
- route: Route<TimeVal, SI, RI, TI>
  Route to scan for trips
- stop: SI
  Stop where boarding should take place
- stopIndex: number
  Index of stop
- fromJourneyStep: JourneyStep<TimeVal, SI, RI, V, CA>
  Journey step from which to board
- cb: (newJourneyStep: JourneyStep<TimeVal, SI, RI, V, CA, "VEHICLE">) => void
  A callback taking any new feasible journey step
Returns void
- Defined in src/McRAPTOR.ts:37

getBestJourneys

getBestJourneys(pt: SI): Journey<TimeVal, SI, RI, V, CA>[][]
Parameters
- pt: SI
Returns Journey<TimeVal, SI, RI, V, CA>[][]
- Defined in src/McRAPTOR.ts:192

`Protected`init

init(): void
Returns void
Overrides BaseRAPTOR.init
- Defined in src/McRAPTOR.ts:77

`Protected`mark

mark(Q: Map<RI, SI>): void
Parameters
- Q: Map<RI, SI>
Returns void
Inherited from BaseRAPTOR.mark
- Defined in src/base.ts:92

run

run(
    ps: SI,
    pt: SI,
    departureTime: TimeVal,
    settings: RAPTORRunSettings,
    rounds?: number,
): void
Parameters
- ps: SI
- pt: SI
- departureTime: TimeVal
- settings: RAPTORRunSettings
- rounds: number = BaseRAPTOR.defaultRounds
Returns void
Inherited from BaseRAPTOR.run
- Defined in src/base.ts:130

`Protected`traceBackFromStep

traceBackFromStep(
from: JourneyStep<TimeVal, SI, RI, V, CA>,
initRound: number,
): Journey<TimeVal, SI, RI, V, CA>
Parameters
- from: JourneyStep<TimeVal, SI, RI, V, CA>
- initRound: number
Returns Journey<TimeVal, SI, RI, V, CA>
Inherited from BaseRAPTOR.traceBackFromStep
- Defined in src/base.ts:163

`Protected`traverseFootPaths

traverseFootPaths(stopId: SI, stop: Stop<SI, RI>): void
Parameters
- stopId: SI
- stop: Stop<SI, RI>
Returns void
Overrides BaseRAPTOR.traverseFootPaths
- Defined in src/McRAPTOR.ts:157

`Protected`traverseRoute

traverseRoute(route: Route<TimeVal, SI, RI, TI>, stop: SI): void
Parameters
- route: Route<TimeVal, SI, RI, TI>
- stop: SI
Returns void
Overrides BaseRAPTOR.traverseRoute
- Defined in src/McRAPTOR.ts:105

`Protected`validFootPaths

validFootPaths(
transfers: ArrayRead<FootPath<SI>>,
): Generator<FootPath<SI>, void, unknown>
Util method to iterate through transfers and stop when required. It takes advantage of the sorting of transfers by ascending transfer length.
Parameters
- transfers: ArrayRead<FootPath<SI>>
  Transfers to iterate
Returns Generator<FootPath<SI>, void, unknown>
An iterator (generator) through transfers
Inherited from BaseRAPTOR.validFootPaths
- Defined in src/base.ts:117

`Protected`walkDuration

walkDuration(length: number): number
Parameters
- length: number
  Length of the path, in m.
Returns number
Duration in ms
Inherited from BaseRAPTOR.walkDuration
- Defined in src/base.ts:59

Class McRAPTOR<TimeVal, V, CA, SI, RI, TI>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns McRAPTOR<TimeVal, V, CA, SI, RI, TI>

Description

Properties

Protectedbags

Description

ProtectedBpt

Protected Readonlycriteria

Protected Readonlydata

Protectedk

Protectedmarked

ProtectedrunParams

StaticdefaultRounds

Accessors

routes

Returns MapRead<RI, Route<TimeVal, SI, RI, TI>>

stops

Returns MapRead<SI, Stop<SI, RI>>

time

Returns Time<TimeVal>

Methods

ProtectedbeginRound

Returns void

Protectedet

Parameters

Returns null | { boardedAt: SI; tripIndex: number }

Description

ProtectedforEachNDEt

Parameters

Returns void

getBestJourneys

Parameters

Returns Journey<TimeVal, SI, RI, V, CA>[][]

Protectedinit

Returns void

Protectedmark

Parameters

Returns void

run

Parameters

Returns void

ProtectedtraceBackFromStep

Parameters

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

ProtectedtraverseFootPaths

Parameters

Returns void

ProtectedtraverseRoute

Parameters

Returns void

ProtectedvalidFootPaths

Parameters

Returns Generator<FootPath<SI>, void, unknown>

ProtectedwalkDuration

Parameters

Returns number

Settings

On This Page

`Protected`bags

`Protected`Bpt

`Protected` `Readonly`criteria

`Protected` `Readonly`data

`Protected`k

`Protected`marked

`Protected`runParams

`Static`defaultRounds

`Protected`beginRound

`Protected`et

`Protected`forEachNDEt

`Protected`init

`Protected`mark

`Protected`traceBackFromStep

`Protected`traverseFootPaths

`Protected`traverseRoute

`Protected`validFootPaths

`Protected`walkDuration