List.iteri<'T> Function (F#)

  • Article

Applies the given function to each element of the collection. The integer passed to the function indicates the index of element.

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

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

// Signature:
List.iteri : (int -> 'T -> unit) -> 'T list -> unit

// Usage:
List.iteri action list

Parameters

  • action
    Type: int -> 'T ->unit

    The function to apply to the elements of the list along with their index.

  • list
    Type: 'Tlist

    The input list.

Remarks

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

Example

The following example demonstrates the use of List.iteri.

let data = ["Cats";"Dogs";"Mice";"Elephants"]
data |> List.iteri (fun i x -> printfn "item %d: %s" i x)

item 0: Cats
item 1: Dogs
item 2: Mice
item 3: Elephants

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

See Also

Reference

Collections.List Module (F#)

Microsoft.FSharp.Collections Namespace (F#)