# \GraphDS\VertexDirectedVertex

Class defining a directed vertex object.

## Summary

Methods
Properties
Constants
__construct()
getValue()
setValue()
addInNeighbor()
removeInNeighbor()
getInNeighbors()
addOutNeighbor()
removeOutNeighbor()
getOutNeighbors()
getNeighbors()
getIndegree()
getOutdegree()
inAdjacent()
outAdjacent()
adjacent()
$neighbors
No constants found
No protected methods found
$value
N/A
No private methods found
No private properties found
N/A

File
  Vertex/DirectedVertex.php
Package
  Default
Class hierarchy
  \GraphDS\Vertex\Vertex
  \GraphDS\Vertex\DirectedVertex

## Tags

None found

## Properties

### $neighbors

    $neighbors : array

Array holding references to all neighboring vertices of this vertex.

#### Type

array

#

Inherited from
  \GraphDS\Vertex\Vertex

## Tags

None found

### $value

    $value : mixed

Variable holding the value of this vertex.

#### Type

mixed

#

Inherited from
  \GraphDS\Vertex\Vertex

## Tags

None found

## Methods

### __construct()

    __construct()

Constructor for DirectedVertex object.

#

Inherited from
  \GraphDS\Vertex\DirectedVertex

## Tags

None found

### getValue()

    getValue() : mixed

Gets the value associated with this vertex.

#### Returns

mixed —

Value associated with this vertex

#

Inherited from
  \GraphDS\Vertex\Vertex

## Tags

None found

### setValue()

    setValue(mixed  $value = null)

Sets the value associated with this vertex.

#### Parameters

mixed | $value | Value to be associated with this vertex

#

Inherited from
  \GraphDS\Vertex\Vertex

## Tags

None found

### addInNeighbor()

    addInNeighbor(string  $vertex)

Adds a neighboring, incoming, directed vertex to this vertex.

#### Parameters

string | $vertex | ID of the vertex

#

Inherited from
  \GraphDS\Vertex\DirectedVertex

## Tags

None found

### removeInNeighbor()

    removeInNeighbor(string  $vertex)

Removes a neighboring, incoming, directed vertex from this vertex.

#### Parameters

string | $vertex | ID of the vertex

#

Inherited from
  \GraphDS\Vertex\DirectedVertex

## Tags

None found

### getInNeighbors()

    getInNeighbors() : array

Returns an array of all incoming neighbor vertices.

#### Returns

array —

Array of all incoming neighbor vertices

#

Inherited from
  \GraphDS\Vertex\DirectedVertex

## Tags

None found

### addOutNeighbor()

    addOutNeighbor(string  $vertex)

Adds a neighboring, outgoing, directed vertex to this vertex.

#### Parameters

string | $vertex | ID of the vertex

#

Inherited from
  \GraphDS\Vertex\DirectedVertex

## Tags

None found

### removeOutNeighbor()

    removeOutNeighbor(string  $vertex)

Removes a neighboring, outgoing, directed vertex from this vertex.

#### Parameters

string | $vertex | ID of the vertex

#

Inherited from
  \GraphDS\Vertex\DirectedVertex

## Tags

None found

### getOutNeighbors()

    getOutNeighbors() : array

Returns an array of all outgoing neighbor vertices.

#### Returns

array —

Array of all outgoing neighbor vertices

#

Inherited from
  \GraphDS\Vertex\DirectedVertex

## Tags

None found

### getNeighbors()

    getNeighbors() : array

Returns an array of all neighboring vertices.

#### Returns

array —

Array of all neighboring vertices

#

Inherited from
  \GraphDS\Vertex\DirectedVertex

## Tags

None found

### getIndegree()

    getIndegree() : integer

Returns the number of incoming neighbor vertices (indegree).

#### Returns

integer —

Number of incoming vertices

#

Inherited from
  \GraphDS\Vertex\DirectedVertex

## Tags

None found

### getOutdegree()

    getOutdegree() : integer

Returns the number of outgoing neighbor vertices (outdegree).

#### Returns

integer —

Number of outgoing vertices

#

Inherited from
  \GraphDS\Vertex\DirectedVertex

## Tags

None found

### inAdjacent()

    inAdjacent(string  $vertex) : boolean

Checks if a given vertex is an incoming neighbor of this vertex.

#### Parameters

string | $vertex | ID of vertex

#### Returns

boolean —

Whether given vertex is an incoming neighbor of this vertex

#

Inherited from
  \GraphDS\Vertex\DirectedVertex

## Tags

None found

### outAdjacent()

    outAdjacent(string  $vertex) : boolean

Checks if a given vertex is an outgoing neighbor of this vertex.

#### Parameters

string | $vertex | ID of vertex

#### Returns

boolean —

Whether given vertex is an outgoing neighbor of this vertex

#

Inherited from
  \GraphDS\Vertex\DirectedVertex

## Tags

None found

### adjacent()

    adjacent(string  $vertex) : boolean

Checks if a given vertex is adjacent to this vertex.

#### Parameters

string | $vertex | ID of vertex

#### Returns

boolean —

Whether given vertex is adjacent to this vertex

#

Inherited from
  \GraphDS\Vertex\DirectedVertex

## Tags

None found

### DirectedVertex.php