Map.forall<'Key,'T> Function (F#)

Article
07/11/2012

Returns true if the given predicate returns true for all of the bindings in the map.

Namespace/Module Path: Microsoft.FSharp.Collections.Map

Assembly: FSharp.Core (in FSharp.Core.dll)

// Signature:
Map.forall : ('Key -> 'T -> bool) -> Map<'Key,'T> -> bool (requires comparison)

// Usage:
Map.forall predicate table

Parameters

predicate
Type: 'Key -> 'T ->bool

The function to test the input elements.
table
Type: Map<'Key,'T>

The input map.

Return Value

true if the predicate evaluates to true for all of the bindings in the map.

Remarks

This function is named ForAll in compiled assemblies. If you are accessing the function from a language other than F#, or through reflection, use this name.

Example

The following code shows how to use Map.forall.

let map1 = Map.ofList [ (1, "one"); (2, "two"); (3, "three") ]
let map2 = Map.ofList [ (-1, "negative one"); (2, "two"); (3, "three") ]
let allPositive = Map.forall (fun key value -> key > 0)
printfn "%b %b" (allPositive map1) (allPositive map2)

Output

true false

Platforms

Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2

Version Information

F# Core Library Versions

Supported in: 2.0, 4.0, Portable

Share via