Class McSharedRAPTOR<TimeVal, V, CA>

Type Parameters

TimeVal
V
CA extends [V, string][]

Hierarchy (View Summary)

McRAPTOR<TimeVal, V, CA, SharedID, number, number>
- McSharedRAPTOR

Index

Constructors

constructor

new McSharedRAPTOR<TimeVal, V, CA extends [V, string][]>(
    data: SharedRAPTORData<TimeVal>,
    criteria: {
        [K in string | number | symbol]: Criterion<
            TimeVal,
            SharedID,
            SharedID,
            CA[K<K>][0],
            CA[K<K>][1],
        >
    },
): McSharedRAPTOR<TimeVal, V, CA>
Type Parameters
- TimeVal
- V
- CA extends [V, string][]
Parameters
- data: SharedRAPTORData<TimeVal>
- criteria: {
      [K in string | number | symbol]: Criterion<
          TimeVal,
          SharedID,
          SharedID,
          CA[K<K>][0],
          CA[K<K>][1],
      >
  }
Returns McSharedRAPTOR<TimeVal, V, CA>
Overrides McRAPTOR.constructor
- Defined in src/shared.ts:67

Properties

`Protected`bags

bags: Map<SharedID, Bag<JourneyStep<TimeVal, SharedID, number, 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, SharedID, number, V, CA>> = null

For target pruning Hence, it's null <=> runParams.pt is null (one-to-all request)

`Protected` `Readonly`criteria

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

`Protected` `Readonly`data

data: SharedRAPTORData<TimeVal>

`Protected`k

k: number = 0

Round k <=> at most k transfers

`Protected`marked

marked: Set<SharedID> = ...

`Protected`runParams

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

Type declaration

null
{
    departureTime: TimeVal;
    ps: SharedID;
    pt: null | SharedID;
    rounds: number;
    settings: RAPTORRunSettings;
}
- departureTime: TimeVal
- ps: SharedID
- pt: null | SharedID
  pt is null if query type is one-to-all ; it disables target-oriented pruning, stopping criteria...
- rounds: number
- settings: RAPTORRunSettings

`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 McRAPTOR.routes
- Defined in src/base.ts:48

stops

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

Returns MapRead<SI, IStop<SI, RI>>
Inherited from McRAPTOR.stops
- Defined in src/base.ts:41

time

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

Methods

`Protected`beginRound

beginRound(): void
Returns void
Inherited from McRAPTOR.beginRound
- Defined in src/McRAPTOR.ts:98

`Protected`et

et(
    route: Route<TimeVal, SharedID, number>,
    p: SharedID,
    after: TimeVal,
    startTripIndex?: number,
): null | { boardedAt: SharedID; tripIndex: number }
Parameters
- route: Route<TimeVal, SharedID, number>
- p: SharedID
  Stop Id.
- after: TimeVal
  Time after which trips should be considered
- startTripIndex: number = 0
  Trip index to start iterating from
Returns null | { boardedAt: SharedID; 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 McRAPTOR.et
- Defined in src/base.ts:73

`Protected`forEachNDEt

forEachNDEt(
    route: Route<TimeVal, SharedID, number, number>,
    stop: SharedID,
    stopIndex: number,
    fromJourneyStep: JourneyStep<TimeVal, SharedID, number, V, CA>,
    cb: (
        newJourneyStep: JourneyStep<
            TimeVal,
            SharedID,
            number,
            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, SharedID, number, number>
  Route to scan for trips
- stop: SharedID
  Stop where boarding should take place
- stopIndex: number
  Index of stop
- fromJourneyStep: JourneyStep<TimeVal, SharedID, number, V, CA>
  Journey step from which to board
- cb: (
  newJourneyStep: JourneyStep<TimeVal, SharedID, number, V, CA, "VEHICLE">,
  ) => void
  A callback taking any new feasible journey step
Returns void
Inherited from McRAPTOR.forEachNDEt
- Defined in src/McRAPTOR.ts:40

getBestJourneys

getBestJourneys(pt: SharedID): Journey<TimeVal, SharedID, SharedID, V, CA>[][]
Parameters
- pt: SharedID
Returns Journey<TimeVal, SharedID, SharedID, V, CA>[][]
Overrides McRAPTOR.getBestJourneys
- Defined in src/shared.ts:86

`Protected`init

init(): void
Returns void
Inherited from McRAPTOR.init
- Defined in src/McRAPTOR.ts:81

`Protected`mark

mark(Q: Map<number, SharedID>): void
Parameters
- Q: Map<number, SharedID>
Returns void
Inherited from McRAPTOR.mark
- Defined in src/base.ts:94

run

run(
    ...params: [
        ps: SharedID,
        pt: null
        | SharedID,
        departureTime: TimeVal,
        settings: RAPTORRunSettings,
        rounds: number,
    ],
): void
Run a RAPTOR query
Parameters
- ...params: [
      ps: SharedID,
      pt: null
      | SharedID,
      departureTime: TimeVal,
      settings: RAPTORRunSettings,
      rounds: number,
  ]
Returns void
Overrides McRAPTOR.run
- Defined in src/shared.ts:74

`Protected`traceBackFromStep

traceBackFromStep(
from: JourneyStep<TimeVal, SharedID, number, V, CA>,
initRound: number,
): Journey<TimeVal, SharedID, number, V, CA>
Parameters
- from: JourneyStep<TimeVal, SharedID, number, V, CA>
- initRound: number
Returns Journey<TimeVal, SharedID, number, V, CA>
Inherited from McRAPTOR.traceBackFromStep
- Defined in src/base.ts:156

`Protected`traverseFootPaths

traverseFootPaths(stopId: SharedID, stop: IStop<SharedID, number>): void
Parameters
- stopId: SharedID
- stop: IStop<SharedID, number>
Returns void
Inherited from McRAPTOR.traverseFootPaths
- Defined in src/McRAPTOR.ts:161

`Protected`traverseRoute

traverseRoute(
route: Route<TimeVal, SharedID, number, number>,
stop: SharedID,
): void
Parameters
- route: Route<TimeVal, SharedID, number, number>
- stop: SharedID
Returns void
Inherited from McRAPTOR.traverseRoute
- Defined in src/McRAPTOR.ts:108

`Protected`walkDuration

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

Class McSharedRAPTOR<TimeVal, V, CA>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns McSharedRAPTOR<TimeVal, V, CA>

Properties

Protectedbags

Description

ProtectedBpt

Protected Readonlycriteria

Protected Readonlydata

Protectedk

Protectedmarked

ProtectedrunParams

Type declaration

departureTime: TimeVal

ps: SharedID

pt: null | SharedID

rounds: number

settings: RAPTORRunSettings

StaticdefaultRounds

Accessors

routes

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

stops

Returns MapRead<SI, IStop<SI, RI>>

time

Returns Time<TimeVal>

Methods

ProtectedbeginRound

Returns void

Protectedet

Parameters

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

Description

ProtectedforEachNDEt

Parameters

Returns void

getBestJourneys

Parameters

Returns Journey<TimeVal, SharedID, SharedID, V, CA>[][]

Protectedinit

Returns void

Protectedmark

Parameters

Returns void

run

Parameters

Returns void

ProtectedtraceBackFromStep

Parameters

Returns Journey<TimeVal, SharedID, number, V, CA>

ProtectedtraverseFootPaths

Parameters

Returns void

ProtectedtraverseRoute

Parameters

Returns void

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`walkDuration