FSharp-Examples

F# is a functional language for .NET. Highly influenced by OCalm, first appeared
in 2005.

$ dotnet new console -lang F# -o Simple 
$ cd Simple  
$ dotnet run

create a new dotnet F# project

#r "nuget: Microsoft.Playwright"

import a nuget library in F# script

Settings

global.json

dotnet and IDEs respect the global.json settings file.

{
  "sdk": {
    "version": "6.0.100",
    "rollForward": "minor"
  }
}

settings.json

Set formatter in Code.

"[fsharp]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "Ionide.Ionide-fsharp"
},

Turn off telemetry

export DOTNET_CLI_TELEMETRY_OPTOUT=1

The current directory
__SOURCE_DIRECTORY__

Runing F# scripts

$ dotnet fsi simple.fsx

alias in .bashrc

alias fx='_fsi(){ dotnet fsi "$@";}; _fsi'

Windows bat file fx.cmd

@echo off

dotnet fsi %*

F# one-liner

echo 'printfn "Hello from Fsharp"' | dotnet fsi --quiet

Run F# script in preview version

$ dotnet fsi --langversion:preview simple.fsx

Create standalone executable

Use win-x64 for Windows.

$ dotnet publish -r linux-x64 -p:PublishSingleFile=true --self-contained false

Command line args

For more complex examples, use Argu module.

let args = fsi.CommandLineArgs[1..] 

let words = Array.collect (fun f -> File.ReadAllLines(f)) args
printfn "%A" words

dotnet fsi simple.fsx *.txt run script

Script

let args2 = fsi.CommandLineArgs |> Array.tail 

for arg in args2 do 
    Console.WriteLine(arg)
done

In program, main

open System

[<EntryPoint>]
let main argv =

    argv |> Array.iter Console.WriteLine

    0

In program, without main

printfn "env.cmdline: %A" <| Environment.GetCommandLineArgs()

Comments

// single line comment

(*
Multi line comment
Multi line comment
*)

/// XML comment
/// <summary>Builds a new string whose characters are the results of applying the function <c>mapping</c>
/// to each of the characters of the input string and concatenating the resulting
/// strings.</summary>
/// ...
val collect : (char -> string) -> string -> string

Read and filter data

 let fileName = __SOURCE_DIRECTORY__ + "/words.txt"

 let data = File.ReadAllLines(fileName)
 let filtered = data |> Array.filter (fun e -> e.StartsWith "c" || e.StartsWith "s") 

 Console.WriteLine(filtered)

Write simple coloured output

For more complex tasks, see Spectre.

module Cons =
    open System

    let log =
        let lockObj = obj ()

        fun color s ->
            lock lockObj (fun _ ->
                Console.ForegroundColor <- color
                printfn "%s" s
                Console.ResetColor())

    let complete = log ConsoleColor.Magenta
    let ok = log ConsoleColor.Green
    let info = log ConsoleColor.DarkBlue
    let warn = log ConsoleColor.Yellow
    let error = log ConsoleColor.Red


module Main =

    let doTask () =
        Cons.error <| "failed to download file"
        Cons.ok <| "success"
        Cons.info <| "operation finished"
        Cons.complete <| "task completed"
        Cons.warn <| "depreciation warning"

    doTask ()

Standard/reverse call

let res = List.map (fun x -> x * x) [1;2;3;4;5]
let res2 = [1;2;3;4;5] |> List.map (fun x -> x * x)

Shuffle list of strings

The program shuffles a list of emoji cards

open System

let cards = [
    "🂡"; "🂱"; "🃁"; "🃑";
    "🂢"; "🂲"; "🃂"; "🃒";
    "🂣"; "🂳"; "🃃"; "🃓";
    "🂤"; "🂴"; "🃄"; "🃔";
    "🂥"; "🂵"; "🃅"; "🃕";
    "🂦"; "🂶"; "🃆"; "🃖";
    "🂧"; "🂷"; "🃇"; "🃗";
    "🂨"; "🂸"; "🂸"; "🂸";
    "🂩"; "🂩"; "🃉"; "🃙";
    "🂪"; "🂺"; "🃊"; "🃚";
    "🂫"; "🂻"; "🃋"; "🃛";
    "🂭"; "🂽"; "🃍"; "🃝";
    "🂮"; "🂾"; "🃎"; "🃞"
]

let show(cards) = 
   
    cards |> Seq.iteri (fun i e -> 
        if i <> 0 && i % 13 = 0 then printf "\n"
        printf "%s " e
    )

        
    printf "\n"

let rnd = Random ()

cards |> Seq.sortBy(fun _ -> rnd.Next()) 
      |> show

Seq.iteri iterates over a list with indexes
A shuffle function is expected in .NET 7

Download image

Blocking request

#r "nuget: FSharp.Data"

open FSharp.Data
open System.IO

let url = "http://webcode.me/favicon.ico"
let body =  Http.Request(url).Body

match body with
| Binary bytes ->
    File.WriteAllBytes("favicon.ico", bytes)
| Text(_) -> failwith "Not Implemented"

Ranges

open System

for i in 1 .. 10 do
    printfn "%i" i

printfn "-----------------"

for i in 1 .. 2 .. 10 do
    printfn "%i" i

printfn "-----------------"

for i in 10 .. -3 .. 0 do
    printfn "%i" i

printfn "-----------------"

seq {
    1 .. 10
} |> Seq.sum |> Console.WriteLine

printfn "-----------------"

let s = seq { for i in 0L .. 10000000L -> i }
s |> Seq.length |> Console.WriteLine

Expressions

In F#, everything is an expression

let f = fun () -> 6
printfn $"{f()}"

let s =
    match 1 with
    | 1 -> "a"
    | _ -> "b"

printfn $"{s}"

let s2 = if true then "a" else "b"
printfn $"{s2}"

let l = let n = 1 in n + 2
printfn "%A" l

Discards

The _ character is a discard which is a placeholder for values that we do not need.

let vals = (1, 2, 3, 4, 5)
let _, _, _, x, y = vals

printfn $"x: {x}; y: {y}"

for _ in 1..4 do
    printfn "falcon"

Printing

to print a single argument without formatting, use Console.WriteLine
the print* functions are F# helpers

open System

let name = "John Doe"

printfn "%s" name
printfn $"{name}"
Console.WriteLine name

printfn "Roger Roe"

print n times with for loop, seq iteration, and pattern matching

let n = 5

for _ in 1..n do
    printfn "falcon"

printfn "---------------------"

seq { 1..n } |> Seq.iter (fun _ -> printfn "falcon")

printfn "---------------------"

let rec printNtimes n = 
    match n with 
    | 0 -> ()
    | _ -> 
        printfn "falcon"
        printNtimes (n-1)

Functional iteration

let vals = [ 1; 2; 3; 4; 5 ]
vals |> List.iter Console.WriteLine

Iterating over elements with a built-in List.iter function

let vals = [ 1; 2; 3; 4; 5 ]

let rec iterate vals =
    match vals with
    | h::t ->
        printfn $"{h}" 
        iterate t // do all over again with the rest of the list
    | [] -> ()

iterate vals

iterating over elements with a custom recursive function utilizing pattern
matching

for loops with ranges

open System

for e in 1 .. 4 do
    Console.WriteLine(e)

for e = 1 to 4 do
    Console.WriteLine(e)

for e = 4 downto 1 do
    Console.WriteLine(e)

Extension methods

Adding new methods to existing types

open System.Globalization

type System.String with
    member this.Reverse =
        seq {
            let enumer = StringInfo.GetTextElementEnumerator(this)

            while enumer.MoveNext() do
                yield enumer.GetTextElement()
        }
        |> Array.ofSeq
        |> Array.rev
        |> String.concat ""


let w = "falcon"
printfn "%s" w
printfn "%s" w.Reverse

let w2 = "žlč"
printfn "%s" w2
printfn "%s" w2.Reverse

let w3 = "नमस्ते"
printfn "%s" w3
printfn "%s" w3.Reverse

let w4 = "Æà𐀀"
printfn "%s" w4
printfn "%s" w4.Reverse

not is a function

let words =
    [ "sky"
      "wind"
      "blue"
      "storm"
      "war"
      "cup"
      "lure"
      "smile" ]

let w1 = "war"

if words |> List.contains w1 then
    printfn "%s found" w1

let w2 = "cloud"

if not(words |> List.contains w2) then
    printfn "%s not found" w2

let w3 = "bin"

if not <| (words |> List.contains w3) then 
    printfn "%s not found" w3

Pipes

printfn "%A" ([1;2;3] |> fun e -> e @ [4;5;6]) // lambda
printfn "%A" ([1;2;3] |> (@) <| [4;5;6]) // point-free
printfn "%A" (([1;2;3], [4;5;6]) ||> (@)) // point-free

// function
let addLists l1 l2 = l1 @ l2
let res = addLists [1;2;3] [4;5;6]

printfn "%A" res

pown is power function for integers

open System

let vals = [| 2; 4; 6; 8 |]

let powered = vals |> Array.map (fun e -> 2 |> pown e)
printfn "%A" powered

This is the same

Array.filter (fun e -> (snd e) > 1)
Array.filter (fun (_, i) -> i >= 2)
Array.filter (snd >> ((<)1))

let matches = rx.Matches(data)

let topTen =
    matches
    |> Seq.map (fun m -> m.Value)
    |> Seq.filter (dig.IsMatch >> not)
    ...

let matches = rx.Matches(data)

let topTen =
     seq {
         for m in matches do
             yield m.Value
     }
     |> Seq.filter (dig.IsMatch >> not)

Seq.sortByDescending snd
Seq.sortBy (fun e -> -(snd e))

Seq.filter (dig.IsMatch >> not)
Seq.filter (fun e -> e |> dig.IsMatch |> not)
Seq.filter (fun e -> dig.IsMatch(e) |> not)
Seq.filter (fun e -> not(dig.IsMatch(e)))

Seq.filter (fun (_, s) -> Seq.length s > 1)
Seq.filter (fun (_, s) -> (s |> Seq.length) > 1)
Seq.filter (fun v -> match v with (_, c) -> c > 1)
Seq.map snd |> Seq.filter (fun t -> Seq.length t > 1)

New methods in F# 6

open System

let d = seq { 1 .. 5}

let d2 = Seq.insertAt 5 6 d
let d3 = Seq.insertManyAt 6 [7; 8; 9; 10] d2
let d4 = Seq.removeAt 9 d3
let d5 = Seq.removeManyAt 0 3 d4
let d6 = Seq.updateAt 0 -4 d5

d6 |> Seq.iter Console.WriteLine

FindAll and filter are similar

let found =
    Array.FindAll(words, (fun e -> e.StartsWith("w") && e.Length = 3))

let found =
    words |> Array.filter (fun e -> e.StartsWith("w") && e.Length = 3)

Find matching first/last element

let first =
    words |> Array.find (fun e -> e.Length = 3)

let last =
    words |> Array.findBack (fun e -> e.Length = 3)

Types

'T, 'U - generic type parameters
^T, ^U - statically resolved type parameters

int list is a synonym for list<int>
'a the tick character in a type name is used for a generic type
a' the tick in a variable name is used to denote a symbol similar to a;
borrowed from math, where ' is used for a derivative or a transposed matrix;
or this name is a close variation of another one, with the unquoted name

let d5'0 = flip (/) 5
let d5'1 = (/) >< 5

let m5'0 = flip (%) 5
let m5'1 = (%) >< 5

The ticks in the names mean that they are close variants of each other

int [,] - two-dimensional array
int [,,] - three-dimensional array

let t1 = (1, 2, 3, 4) // int * int * int * int
let t2 = (4, "falcon", true) // int * string * bool

In tuples, the types for elements are separated with * character

let f (x:int): int = x + 1 - f is a function; it takes an int as a parameter
and returns an integer

// g : int * string -> unit
let g(x, s) = 
    printfn "%d %s" x s

g is a function which takes an integer and a string as a parameter; it
returns unit (nothing); this function is said to have a side-effect

// int -> string -> unit
let f1 x s = 
    printfn "%d %s" x s

// int * string -> unit
let f2(x,s) = 
    printfn "%d %s" x s
    
f1 3 "falcons"   
f2(3, "falcons")

f1's arguments are curried, whereas f2's arguments are tupled

Partition function

open System.IO

let files = Directory.GetFiles(".")

let data = files 
        |> Array.partition(fun e -> e.EndsWith("txt"))

let matched = fst data
printfn "%A" matched

let output = matched |> Array.map (fun e -> e.TrimStart('.', '/'))
printfn "%A" output

partition files into two groups: txt files and the rest

Discriminated unions

type Suit =
    | Spades
    | Clubs
    | Diamonds
    | Hearts

type Face =
    | Two
    | Three
    | Four
    | Five
    | Six
    | Seven
    | Eight
    | Nine
    | Ten
    | Jack
    | Queen
    | King
    | Ace

type Card = { Face: Face; Suit: Suit }

let suits = [ Spades; Clubs; Diamonds; Hearts ]

let faces =
    [ Two
      Three
      Four
      Five
      Six
      Seven
      Eight
      Nine
      Ten
      Jack
      Queen
      King
      Ace ]

let deck =
    [ for suit in suits do
          for face in faces do
              yield { Face = face; Suit = suit } ]

deck |> printfn "%A"

Active patterns

Active patterns define ad hoc union data structures for easy pattern matching

let (|Even|Odd|) n =
    if n % 2 = 0 then
        Even
    else
        Odd

is equal to

type NumKind =
    | Even
    | Odd

let GetChoice n =
    if n % 2 = 0 then
        Even
    else
        Odd

open System

let (|Even|Odd|) n = if n % 2 = 0 then Even else Odd

let testNum n =
    match n with
    | Even -> sprintf "%i is even" n
    | Odd -> sprintf "%i is odd" n

[ 12; 11; 4; 5; 6; 7; 8; 9 ]
|> List.map (testNum)
|> List.iter Console.WriteLine

calc pow

Algorithm to calculate powers; F# script with
#time directive

let rec power x n: bigint =
    if n = 0I then 1I
    else x * (power x (n-1I))

// more efficient algorithm
let rec power2 x n: bigint =
    if n = 0I then 1I
    // if n is even
    elif (n % 2I = 0I) then ((power2 x (n/2I)) * (power2 x (n/2I)))
     // if n is odd
    else x * (power2 x (n-1I))

#time
//printfn "%A" (power 1254I 29_000I)
printfn "%A" (power2 1254I 29_000I)
#time

Point-free

Point-free programming is a paradigm that advocates the formulation of
programs by means of function composition. In the point-free style programs
avoid explicitly nominating function arguments (or "points"), deriving
instead complex function definitions by means of applying higher-order
combinators on simpler functions.

let vals = [1 .. 15]

// point-free
let flip f = fun x y -> f y x
let filtered = vals |> List.filter ((=) 0 << flip (%) 2)

printfn "%A" filtered

// lambda
let filtered2 = vals |> List.filter (fun n -> n % 2 = 0)

printfn "%A" filtered2

Stopwatch

Custom timing fun with StopWatch

open System.Diagnostics
open System.Threading


let time f =

  let stopwatch = Stopwatch.StartNew()

  f()

  stopwatch.Stop()
  
  printfn "%O" stopwatch.Elapsed


time (fun () -> Thread.Sleep(2000))

Read XML with XmlProvider

<?xml version="1.0" encoding="utf-8"?>
<products>
    <product>
        <id>1</id>
        <name>Product A</name>
        <price>780</price>
    </product>

    <product>
        <id>2</id>
        <name>Product B</name>
        <price>1100</price>
    </product>

    <product>
        <id>3</id>
        <name>Product C</name>
        <price>1050</price>
    </product>

    <product>
        <id>4</id>
        <name>Product D</name>
        <price>950</price>
    </product>
</products>

open FSharp.Data
open System

type xml = XmlProvider<"data.xml">

let d = xml.GetSample().Products
d |> Seq.iter (fun p -> Console.WriteLine($"{p.Name} {p.Price}"))


let res = d |> Seq.filter (fun p -> p.Price < 1000)

for v in res do 
    Console.WriteLine v

Console.WriteLine("---------------------------")

Console.WriteLine(d[0].Price.GetType())

Console.WriteLine("---------------------------")

d[3..4] |> Array.iter (Console.WriteLine)

Console.WriteLine("---------------------------")

printfn "%A" d[..2]

Projections

We do projections when we select particular columns/fields from are data source

type User =
    { FirstName: string
      LastName: string
      Occupation: string
      Salary: int }

let users = [
        { FirstName="Robert"; LastName="Novak"; Occupation="teacher"; Salary=1770 }
        { FirstName="John"; LastName="Doe"; Occupation="gardener";  Salary=1230 }
        { FirstName="Lucy"; LastName="Novak"; Occupation="accountant";  Salary=670 }
        { FirstName="Ben"; LastName="Walter"; Occupation="teacher";  Salary=2050 }
        { FirstName="Robin"; LastName="Brown"; Occupation="bartender";  Salary=2300 }
        { FirstName="Amy"; LastName="Doe"; Occupation="technician";  Salary=1250 }
        { FirstName="Joe"; LastName="Draker"; Occupation="musician";  Salary=1190 }
        { FirstName="Janet"; LastName="Doe"; Occupation="actor";  Salary=980 }
        { FirstName="Peter"; LastName="Novak"; Occupation="singer";  Salary=990 }
        { FirstName="Albert"; LastName="Novak"; Occupation="teacher";  Salary=1930 }
]

let users2 =
    users
    |> List.map (fun e ->
        {| FirstName = e.FirstName
           LastName = e.LastName |})

users2 |> List.take 3 |> List.iter (printfn "%A")

printfn "---------------------"

query {
    for user in users do
    select {| FirstName = user.FirstName; LastName = user.LastName |}
    take 3
} |> Seq.iter (printfn "%A")

In the example, we select FirstName and LastName fields

Filter users having above average salary

open System

type User =
    { FirstName: string
      LastName: string
      Salary: int }

let users = [
    
        { FirstName="Robert"; LastName="Novak"; Salary=1770 };
        { FirstName="John"; LastName="Doe";  Salary=1230 };
        { FirstName="Lucy"; LastName="Novak";  Salary=670 };
        { FirstName="Ben"; LastName="Walter";  Salary=2050 };
        { FirstName="Robin"; LastName="Brown";  Salary=2300 };
        { FirstName="Amy"; LastName="Doe";  Salary=1250 };
        { FirstName="Joe"; LastName="Draker";  Salary=1190 };
        { FirstName="Janet"; LastName="Doe";  Salary=980 };
        { FirstName="Peter"; LastName="Novak";  Salary=990 };
        { FirstName="Albert"; LastName="Novak";  Salary=1930 }
]

let avg = users |> List.averageBy (fun user -> float user.Salary)
let users2 = users |> List.filter (fun user -> user.Salary > int avg)

users2 |> List.iter Console.WriteLine

Get n words from sentence

open System

[<EntryPoint>]
let main argv =

    let n = argv[0] |> int
//    let n = 4

    let msg = "There are three falcons in the sky."
    let output = msg.Split() |> Array.take n |> String.concat " "

    Console.WriteLine output
    0

F# 6 task expressions

F# 6 introduced task expressions, which simplify interoperatibility with .NET libraries
that create or consume .NET tasks.

#r "nuget: Microsoft.Playwright"

open Microsoft.Playwright

let createScreenshot () =
    async {
        use! web = Playwright.CreateAsync() |> Async.AwaitTask
        let! browser = web.Chromium.LaunchAsync() |> Async.AwaitTask
        let! page = browser.NewPageAsync() |> Async.AwaitTask
        let! _ = page.GotoAsync("http://webcode.me") |> Async.AwaitTask
        let screenshotOptions = PageScreenshotOptions()
        screenshotOptions.Path <- "webcode.png"

        let! _ = page.ScreenshotAsync(screenshotOptions) |> Async.AwaitTask
        ()
    } |> Async.StartAsTask

createScreenshot ()
|> Async.AwaitTask
|> Async.RunSynchronously

printfn "Screenshot created"

The example is simplified into:

#r "nuget: Microsoft.Playwright"

open Microsoft.Playwright

let createScreenshot () =
    task {
        use! web = Playwright.CreateAsync()
        let! browser = web.Chromium.LaunchAsync()
        let! page = browser.NewPageAsync()
        let! _ = page.GotoAsync("http://webcode.me")
        let screenshotOptions = PageScreenshotOptions()
        screenshotOptions.Path <- "webcode.png"

        let! _ = page.ScreenshotAsync(screenshotOptions)
        ()
    }

createScreenshot ()
|> Async.AwaitTask
|> Async.RunSynchronously

printfn "Screenshot created"

Charts

In interactive notebook:

#r "nuget: XPlot.Plotly, 4.0.6"
#r "nuget:xplot.plotly.interactive"

open XPlot.Plotly

let trace1 =
    Scatter(
        x = [1; 2; 3; 4],
        y = [10; 15; 13; 17]
    )

let trace2 =
    Scatter(
        x = [2; 3; 4; 5],
        y = [16; 5; 11; 9]
    )

let chart1 =
    [trace1; trace2]
    |> Chart.Plot
    |> Chart.WithWidth 700
    |> Chart.WithHeight 500

chart1

Outside notebook:

#r "nuget: XPlot.Plotly, 4.0.6"

open XPlot.Plotly
open System.IO

let trace1 =
    Scatter(
        x = [1; 2; 3; 4],
        y = [10; 15; 13; 17]
    )

let trace2 =
    Scatter(
        x = [2; 3; 4; 5],
        y = [16; 5; 11; 9]
    )

let chart1 =
    [trace1; trace2]
    |> Chart.Plot
    |> Chart.WithWidth 700
    |> Chart.WithHeight 500


let html = chart1.GetHtml()
File.WriteAllText("linechart.html", html)

QuestPDF

Generate PDF files with QuestPDF

#r "nuget: QuestPDF, 2022.12.1"

open QuestPDF.Fluent
open QuestPDF.Helpers
open QuestPDF.Infrastructure
open System.Diagnostics

let filename = "text.pdf"

Document
    .Create(fun container ->
        container.Page (fun page ->
            page.Size(PageSizes.A4)
            page.Margin(2f, Unit.Centimetre)
            page.PageColor(Colors.White)
            page.DefaultTextStyle(fun x -> x.FontSize(20f))

            page
                .Header()
                .AlignCenter()
                .Text("My Title")
                .SemiBold()
                .FontSize(36f)
                .FontColor(Colors.Blue.Medium)
            |> ignore

            page
                .Content()
                .Text(fun text ->
                    text.EmptyLine() |> ignore
                    text.Line("A long stormy night") |> ignore
                    text.EmptyLine() |> ignore
                    text.Line("An old falcon") |> ignore
                    text.EmptyLine() |> ignore))
        |> ignore)
    .GeneratePdf(filename)

Process.Start("explorer", filename) |> ignore

Deedle

Working with dataframes

#r "nuget: FSharp.Data"
#r "nuget: Deedle"

open FSharp.Data
open Deedle

let url =  @"https://raw.githubusercontent.com/dotnet/machinelearning/master/test/data/housing.txt"

let data = Http.RequestString url

// get a frame containing the values of houses at the charles river only
let df = 
    Frame.ReadCsvString(data, separators="\t")
    |> Frame.sliceCols ["MedianHomeValue"; "CharlesRiver"]
    |> Frame.filterRowValues (fun s -> s.GetAs<bool>("CharlesRiver"))

df.Print()

Name		Name	Last commit message	Last commit date
Latest commit History 393 Commits
basics		basics
database		database
functional		functional
functions		functions
gui/eto		gui/eto
http		http
modules/Simple		modules/Simple
operators		operators
.gitignore		.gitignore
README.md		README.md
argu.md		argu.md
arrays.md		arrays.md
async.md		async.md
builder.md		builder.md
conditions.md		conditions.md
email.md		email.md
ftp-client.md		ftp-client.md
http-client.md		http-client.md
io.md		io.md
json.md		json.md
list-comprehension.md		list-comprehension.md
lists.md		lists.md
loops.md		loops.md
maps.md		maps.md
pattern-match.md		pattern-match.md
playwright.md		playwright.md
query-expressions.md		query-expressions.md
random.md		random.md
records.md		records.md
regex.md		regex.md
sorting.md		sorting.md
strings.md		strings.md
template.md		template.md

janbodnar/FSharp-Examples

Folders and files

Latest commit

History

Repository files navigation