successors

Find successive state indices and costs

Since R2023a

Syntax

[succIDS,costs] = successors(graph,currID)

Description

[succIDS,costs] = successors(graph,currID) finds the state indices succIDS and the cost of all states costs that are connected to the specified state currID using the directed link.

Examples

Find Successive State Indices and Costs in navGraph Object

Load navGraph data for states and links.

load navGraphData.mat

Visualize the navGraph object.

show(navGraphObj);

Find successive state indices and costs based on a state name.

[succIDS,costs] = successors(navGraphObj,"G")

succIDS = 2×1

     1
     8

costs = 2×1

   38.7759
   13.9383

Find the state vectors of the successive states.

states = index2state(navGraphObj,succIDS)

states = 2×3

    8.0000    2.0000    0.7218
    8.0000    7.0000    0.6741

Input Arguments

graph — Graph object

navGraph object

Graph object, specified as a navGraph object.

currID — Current state

positive integer | string scalar | character vector

Current state, specified as a positive integer, representing a state index, or as a string scalar or character vector representing a state name.

Data Types: double | char | string

Output Arguments

succIDS — Successive state indices

column vector of positive integers

Successive state indices, returned as a column vector of positive integers.

Data Types: double

costs — Cost of all successive states

numeric column vector

Cost of all successive states, returned as a numeric column vector of the same size as succIDS. The function computes costs using the Weight or LinkWeightFcn property of the navGraph object graph.

Data Types: double

Extended Capabilities

C/C++ Code Generation

Generate C and C++ code using MATLAB® Coder™.

State names are not supported for code generation. Use state index to specify current state as input.

Version History

Introduced in R2023a