On this page:
2.1 Datatypes and Unions
2.2 Type Errors
Version: 5.0.1

2 Beginning Typed Racket

Recall the typed module from Quick Start:

  #lang typed/racket
  (define-struct: pt ([x : Real] [y : Real]))
  
  (: mag (pt -> Number))
  (define (mag p)
    (sqrt (+ (sqr (pt-x p)) (sqr (pt-y p)))))

Let us consider each element of this program in turn.

  #lang typed/racket

This specifies that the module is written in the typed/racket language, which is a typed version of the racket language. Typed versions of other languages are provided as well; for example, the typed/racket/base language corresponds to racket/base.

  (define-struct: pt ([x : Real] [y : Real]))

Many forms in Typed Racket have the same name as the untyped forms, with a : suffix.

This defines a new structure, name pt, with two fields, x and y. Both fields are specified to have the type Real, which corresponds to the real numbers. The define-struct: form corresponds to the define-struct form from racket – when porting a program from racket to typed/racket, uses of define-struct should be changed to define-struct:.

  (: mag (pt -> Number))

This declares that mag has the type (pt -> Number).

The type (pt -> Number) is a function type, that is, the type of a procedure. The input type, or domain, is a single argument of type pt, which refers to an instance of the pt structure. The -> both indicates that this is a function type and separates the domain from the range, or output type, in this case Number.

  (define (mag p)
    (sqrt (+ (sqr (pt-x p)) (sqr (pt-y p)))))

This definition is unchanged from the untyped version of the code. The goal of Typed Racket is to allow almost all definitions to be typechecked without change. The typechecker verifies that the body of the function has the type Real, under the assumption that p has the type pt, taking these types from the earlier type declaration. Since the body does have this type, the program is accepted.

2.1 Datatypes and Unions

Many data structures involve multiple variants. In Typed Racket, we represent these using union types, written (U t1 t2 ...).

  #lang typed/racket
  (define-type Tree (U leaf node))
  (define-struct: leaf ([val : Number]))
  (define-struct: node ([left : Tree] [right : Tree]))
  
  (: tree-height (Tree -> Integer))
  (define (tree-height t)
    (cond [(leaf? t) 1]
          [else (max (+ 1 (tree-height (node-left t)))
                     (+ 1 (tree-height (node-right t))))]))
  
  (: tree-sum (Tree -> Number))
  (define (tree-sum t)
    (cond [(leaf? t) (leaf-val t)]
          [else (+ (tree-sum (node-left t))
                   (tree-sum (node-right t)))]))

In this module, we have defined two new datatypes: leaf and node. We’ve also defined the type name Tree to be (U node leaf), which represents a binary tree of numbers. In essence, we are saying that the tree-height function accepts a Tree, which is either a node or a leaf, and produces a number.

In order to calculate interesting facts about trees, we have to take them apart and get at their contents. But since accessors such as node-left require a node as input, not a Tree, we have to determine which kind of input we were passed.

For this purpose, we use the predicates that come with each defined structure. For example, the leaf? predicate distinguishes leafs from all other Typed Racket values. Therefore, in the first branch of the cond clause in tree-sum, we know that t is a leaf, and therefore we can get its value with the leaf-val function.

In the else clauses of both functions, we know that t is not a leaf, and since the type of t was Tree by process of elimination we can determine that t must be a node. Therefore, we can use accessors such as node-left and node-right with t as input.

2.2 Type Errors

When Typed Racket detects a type error in the module, it raises an error before running the program.

Example:

  > (add1 "not a number")

  eval:2:0: Type Checker: No function domains matched in

  function application:

  Domains: Exact-Positive-Integer

           Natural

           Integer

           Exact-Rational

           Nonnegative-Float

           Float

           Real

           Inexact-Complex

           Complex

  Arguments: String

   in: (#%app add1 (quote "not a number"))