ContainerBidirectionalIterator<TValue> Class

Definition

Namespace:

Microsoft.VisualC.StlClr.Generic

Assembly:

Microsoft.VisualC.STLCLR.dll

Defines an iterator that can access elements in a container in the forward direction by using the increment operator and in the backward direction by using the decrement operator. The element that the iterator points to can be both written to and read from any number of times. Bidirectional iterators can be used anywhere that an input or output iterator is required.

generic <typename TValue>
public ref class ContainerBidirectionalIterator : Microsoft::VisualC::StlClr::Generic::IBidirectionalIterator<TValue>

public class ContainerBidirectionalIterator<TValue> : Microsoft.VisualC.StlClr.Generic.IBidirectionalIterator<TValue>

type ContainerBidirectionalIterator<'Value> = class
    interface IBidirectionalIterator<'Value>

Public Class ContainerBidirectionalIterator(Of TValue)
Implements IBidirectionalIterator(Of TValue)

Type Parameters

TValue

The type of an element in the controlled sequence.

Inheritance

Object

ContainerBidirectionalIterator<TValue>

Implements

IBaseIterator<TValue> IBidirectionalIterator<TValue> IForwardIterator<TValue> IInputIterator<TValue> IOutputIterator<TValue> ICloneable

Remarks

Some methods, especially operators, declare a type for a parameter but do not specify a parameter name. Such a parameter is known as an unnamed parameter. In the documentation for these methods, the A_0 placeholder represents the unnamed parameter.

Constructors

ContainerBidirectionalIterator<TValue>()	Allocates and initializes a new ContainerBidirectionalIterator<TValue> object.
ContainerBidirectionalIterator<TValue>(ContainerBidirectionalIterator<TValue>)	Allocates and initializes a new ContainerBidirectionalIterator<TValue> object from an existing ContainerBidirectionalIterator<TValue> object.
ContainerBidirectionalIterator<TValue>(INode<TValue>)	Allocates and initializes a new ContainerBidirectionalIterator<TValue> object that points to the given node.

Methods

Clone()	Returns a copy of the current ContainerBidirectionalIterator<TValue> object.
container()	Gets the container that the iterator is traversing.
equal_to(ContainerBidirectionalIterator<TValue>)	Determines whether the given ContainerBidirectionalIterator<TValue> object is the same as the current ContainerBidirectionalIterator<TValue> object.
equal_to(IInputIterator<TValue>)	Determines if the given IInputIterator<TValue> object is the same as the current ContainerBidirectionalIterator<TValue> object.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
get_bias()	Gets the bias of the iterator. The bias is the offset of the iterator from element zero.
get_cref()	Returns a constant reference to the element that the iterator is currently pointing to.
get_node()	Gets the node, or element, that the iterator is pointing to.
get_ref()	Returns a reference to the element that the iterator is currently pointing to.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
next()	Increments the iterator to the next position in the underlying container, or to the first position beyond the end of container if the container has been completely traversed.
prev()	Positions the iterator to the element immediately before the current element.
ToString()	Returns a string that represents the current object. (Inherited from Object)
valid()	Determines whether the iterator is valid and can be safely used to traverse the underlying container.

Operators

Assign(ContainerBidirectionalIterator<TValue>)	Assigns the given ContainerBidirectionalIterator<TValue> object to the current object.
Decrement(ContainerBidirectionalIterator<TValue>)	Decrements the iterator by one element. This is the prefix version of the decrement operator.
Decrement(Int32, Int32)	Decrements the iterator by one element. This is the postfix version of the decrement operator.
Equality(ContainerBidirectionalIterator<TValue>)	Determines whether the given ContainerBidirectionalIterator<TValue> object is the same as the current ContainerBidirectionalIterator<TValue> object.
Equality(IInputIterator<TValue>)	Determines whether the given IInputIterator<TValue> object is the same as the current ContainerBidirectionalIterator<TValue> object.
Implicit	Converts a ContainerBidirectionalIterator<TValue> to an IBidirectionalIterator<TValue>.
Increment(ContainerBidirectionalIterator<TValue>)	Increments the iterator by one element. This is the prefix version of the increment operator.
Increment(Int32, Int32)	Increments the iterator by one element. This is the postfix version of the increment operator.
Inequality(ContainerBidirectionalIterator<TValue>)	Determines whether the given ContainerBidirectionalIterator<TValue> object differs from the current ContainerBidirectionalIterator<TValue> object.
Inequality(IInputIterator<TValue>)	Determines whether the given IInputIterator<TValue> object differs from the current ContainerBidirectionalIterator<TValue> object.
MemberSelection(ContainerBidirectionalIterator<TValue>)	Returns the element that the iterator is currently pointing to.
PointerDereference(ContainerBidirectionalIterator<TValue>)	Returns the element that the iterator is currently pointing to.