FSharp.Collections.Immutable 1.0.0

Edit this page

Queue Module

Functions and values

Function or value Description

Queue.average queue

Full Usage: Queue.average queue

Parameters:
Returns: ^a
Modifiers: inline
Type parameters: ^a
queue : IQueue<^a>
Returns: ^a

Queue.averageBy projection queue

Full Usage: Queue.averageBy projection queue

Parameters:
    projection : 'a -> ^b
    queue : IQueue<'c>

Returns: 'a seq -> ^b
Modifiers: inline
Type parameters: 'a, ^b, 'c
projection : 'a -> ^b
queue : IQueue<'c>
Returns: 'a seq -> ^b

Queue.clear queue

Full Usage: Queue.clear queue

Parameters:
Returns: IQueue<'a>
queue : IQueue<'a>
Returns: IQueue<'a>

Queue.empty

Full Usage: Queue.empty

Returns: Queue<'T>
Modifiers: inline
Type parameters: 'T
Returns: Queue<'T>

Queue.enqueue item queue

Full Usage: Queue.enqueue item queue

Parameters:
    item : 'a
    queue : IQueue<'a>

Returns: IQueue<'a>
item : 'a
queue : IQueue<'a>
Returns: IQueue<'a>

Queue.exists predicate queue

Full Usage: Queue.exists predicate queue

Parameters:
    predicate : 'a -> bool
    queue : IQueue<'a>

Returns: bool
predicate : 'a -> bool
queue : IQueue<'a>
Returns: bool

Queue.filter predicate queue

Full Usage: Queue.filter predicate queue

Parameters:
    predicate : 'a -> bool
    queue : IQueue<'a>

Returns: IQueue<'a>
predicate : 'a -> bool
queue : IQueue<'a>
Returns: IQueue<'a>

Queue.find predicate queue

Full Usage: Queue.find predicate queue

Parameters:
    predicate : 'a -> bool
    queue : IQueue<'a>

Returns: 'a
predicate : 'a -> bool
queue : IQueue<'a>
Returns: 'a

Queue.findIndex predicate queue

Full Usage: Queue.findIndex predicate queue

Parameters:
    predicate : 'a -> bool
    queue : IQueue<'a>

Returns: int
predicate : 'a -> bool
queue : IQueue<'a>
Returns: int

Queue.fold folder state queue

Full Usage: Queue.fold folder state queue

Parameters:
    folder : 'a -> 'b -> 'a
    state : 'a
    queue : IQueue<'b>

Returns: 'a
folder : 'a -> 'b -> 'a
state : 'a
queue : IQueue<'b>
Returns: 'a

Queue.forall predicate queue

Full Usage: Queue.forall predicate queue

Parameters:
    predicate : 'a -> bool
    queue : IQueue<'b>

Returns: 'a seq -> bool
predicate : 'a -> bool
queue : IQueue<'b>
Returns: 'a seq -> bool

Queue.head queue

Full Usage: Queue.head queue

Parameters:
Returns: 'a
queue : IQueue<'a>
Returns: 'a

Queue.isEmpty queue

Full Usage: Queue.isEmpty queue

Parameters:
Returns: bool
queue : IQueue<'a>
Returns: bool

Queue.iter action queue

Full Usage: Queue.iter action queue

Parameters:
    action : 'a -> unit
    queue : IQueue<'a>

action : 'a -> unit
queue : IQueue<'a>

Queue.iter2 action queue1 queue2

Full Usage: Queue.iter2 action queue1 queue2

Parameters:
    action : 'a -> 'b -> unit
    queue1 : IQueue<'a>
    queue2 : IQueue<'b>

action : 'a -> 'b -> unit
queue1 : IQueue<'a>
queue2 : IQueue<'b>

Queue.iteri action queue

Full Usage: Queue.iteri action queue

Parameters:
    action : int -> 'a -> unit
    queue : IQueue<'a>

action : int -> 'a -> unit
queue : IQueue<'a>

Queue.ofSeq source

Full Usage: Queue.ofSeq source

Parameters:
    source : 'T seq

Returns: Queue<'T>
Modifiers: inline
Type parameters: 'T
source : 'T seq
Returns: Queue<'T>

Queue.pick chooser queue

Full Usage: Queue.pick chooser queue

Parameters:
    chooser : 'a -> 'b option
    queue : IQueue<'a>

Returns: 'b
chooser : 'a -> 'b option
queue : IQueue<'a>
Returns: 'b

Queue.reduce reduction queue

Full Usage: Queue.reduce reduction queue

Parameters:
    reduction : 'a -> 'a -> 'a
    queue : IQueue<'a>

Returns: 'a
reduction : 'a -> 'a -> 'a
queue : IQueue<'a>
Returns: 'a

Queue.singleton item

Full Usage: Queue.singleton item

Parameters:
    item : 'T

Returns: Queue<'T>
Modifiers: inline
Type parameters: 'T
item : 'T
Returns: Queue<'T>

Queue.sum queue

Full Usage: Queue.sum queue

Parameters:
Returns: ^a
Modifiers: inline
Type parameters: ^a
queue : IQueue<^a>
Returns: ^a

Queue.sumBy projection queue

Full Usage: Queue.sumBy projection queue

Parameters:
    projection : 'a -> ^b
    queue : IQueue<'a>

Returns: ^b
Modifiers: inline
Type parameters: 'a, ^b
projection : 'a -> ^b
queue : IQueue<'a>
Returns: ^b

Queue.tail queue

Full Usage: Queue.tail queue

Parameters:
Returns: IQueue<'a>
queue : IQueue<'a>
Returns: IQueue<'a>

Queue.toSeq queue

Full Usage: Queue.toSeq queue

Parameters:
Returns: 'a seq
Modifiers: inline
Type parameters: 'a
queue : Queue<'a>
Returns: 'a seq

Queue.tryFind predicate queue

Full Usage: Queue.tryFind predicate queue

Parameters:
    predicate : 'a -> bool
    queue : IQueue<'a>

Returns: 'a option
predicate : 'a -> bool
queue : IQueue<'a>
Returns: 'a option

Queue.tryFindIndex predicate queue

Full Usage: Queue.tryFindIndex predicate queue

Parameters:
    predicate : 'a -> bool
    queue : IQueue<'a>

Returns: int option
predicate : 'a -> bool
queue : IQueue<'a>
Returns: int option

Queue.tryPick chooser queue

Full Usage: Queue.tryPick chooser queue

Parameters:
    chooser : 'a -> 'b option
    queue : IQueue<'a>

Returns: 'b option
chooser : 'a -> 'b option
queue : IQueue<'a>
Returns: 'b option

Active patterns

Active pattern Description

Queue.(|Cons|Nil|) queue

Full Usage: Queue.(|Cons|Nil|) queue

Parameters:
Returns: Choice<('a * IQueue<'a>), unit>
queue : IQueue<'a>
Returns: Choice<('a * IQueue<'a>), unit>