Concept PropertyMapConceptConcept for maps from contained elements (such as graph vertices or index nodes) to values.
Concept for maps from contained elements (such as graph vertices or index nodes) to values.
Defined in | <seqan/graph_types.h> |
---|---|
Signature |
concept PropertyMapConcept;
|
Interface Function Overview
-
void assignProperty(pm, d, val);
Assigns a property to an item in the property map. -
TGetValue getProperty(pm, d);
Get method for an item's property. -
TReference property(pm, d);
Accesses the property of an item in the property map. -
void resize(pm, len[, val]);
Resize a sequence.
Interface Metafunction Overview
-
GetValue<TPropertyMap>::Type
Returns the get-value type of the property map. -
Reference<TPropertyMap>::Type
Returns the reference type of the property map. -
Value<TPropertyMap>::Type
Returns the value type of the property map.
Interface Functions Detail
void assignProperty(pm, d, val);
Assigns a property to an item in the property map.
Parameters
pm
|
The property map |
---|---|
d
|
A vertex or edge descriptor that identifies the item in the property map. |
val
|
The new value, where the type of the new value must match the value type of the property map. |
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TGetValue getProperty(pm, d);
Get method for an item's property.
Parameters
pm
|
The property map. |
---|---|
d
|
A vertex or edge descriptor that identifies the item in the property map. |
Returns
TGetValue |
Get-value to the item in the property map of type GetValue. |
---|
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TReference property(pm, d);
Accesses the property of an item in the property map.
Parameters
pm
|
The property map. |
---|---|
d
|
A vertex or edge descriptor that identifies the item in the property map. |
Returns
TReference |
Reference to the item in the property map of type Reference. |
---|
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
void resize(pm, len[, val]);
Resize a sequence.
Parameters
seq
|
Sequence to resize. |
---|---|
len
|
Length to resize seq to. |
val
|
When increasing the size, val is used to fill new entries. When omitted, TValue() is used where TValue is the Value type of the sequence. |
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.