is_branch_globally_homogeneous.tempnetwork: Is a function that checks whether the 'tempflow'-object of...

Description Usage Arguments Value

View source: R/tempnetwork-tempflow-predicates.R

Description

Is a function that checks whether the 'tempflow'-object of the given 'tempnetwork'-object is globally homogeneous in between the two given points. That is, whether every path between the two points in time has the same size (or length).

Usage

1
2
3
4
## S3 method for class 'tempnetwork'
is_branch_globally_homogeneous(tempNetwork,
  startPoint, endPoint, considerWeights = TRUE, considerLoops = TRUE,
  safe = TRUE)

Arguments

tempNetwork

A 'tempnetwork'-object.

considerWeights

If TRUE weights will be considered in the computation of the shortest paths, otherwise the distance will be equal to the number of steps.

safe

If TRUE, it will be tested, whether the given point-names (or point-ids) are present in the 'tempflow'-object of the given 'tempnetwork'-object.

srcPoint

The point-name (or point-id) of the start-point of the computation.

trgPoint

The point-name (or point-id) of the end-point of the computation.

checkForLoops

If FALSE, loops will be ignored in the computation. That is, only paths without loops will be considered.

Value

A truth value indicating whether the undelying flow is globally homogeneous inbetween the two given points.


KonstantinRK/tempnetwork documentation built on Dec. 23, 2019, 6:40 p.m.