Main Content

getrelatives (biograph)

(To be removed) Find relatives of a node in biograph object

getrelatives (biograph) will be removed in a future release. Use neighbors instead. Note that the function does not let you specify NumGenerations. You can use distances to find the distances from all nodes to the target node after setting the edge weight to 1, and filter the nodes by distance to the appropriate depth.

Syntax

Nodes = getrelatives(BiographNode)
Nodes = getrelatives(BiographNode,NumGenerations)

Arguments

BiographNode

Node in a biograph object.

NumGenerations

Number of generations. Enter a positive integer.

Description

Nodes = getrelatives(BiographNode) finds all the direct relatives for a given node (BiographNode).

Nodes = getrelatives(BiographNode,NumGenerations) finds the direct relatives for a given node (BiographNode) up to a specified number of generations (NumGenerations). If the NumGenerations is 0, the function returns the node itself.

Version History

Introduced before R2006a

expand all

Warns starting in R2022a