Skip to content

Add 0.5 docs #3579

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 1, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/reference/changed/implicit-resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ affect implicits on the language level.
/*!*/ def f(implicit x: y.type) // error `y.type` not allowed as type of implicit

3. Nesting is now taken into account for selecting an implicit.
Consider for instance the following scenario
Consider for instance the following scenario:

def f(implicit i: C) = {
def g(implicit j: C) = {
Expand Down
48 changes: 48 additions & 0 deletions docs/docs/reference/dependent-function-types.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
layout: doc-page
title: "Dependent Function Types"
---

A dependent function type describes functions where the result type may depend
on the function's parameter values. Example:

class Keyed { type Key; key: Key }
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keyed and Key are a bit too easy to confuse when following the example. I would maybe replace Keyed by Entry.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, let's do this.


def extractKey(k: Keyed): k.Key = k.key // a dependent method
val extractor: (k: Keyed) => k.Key = extractKey // a dependent function value

Scala already has _dependent methods_, i.e. methods where the result
type refers to some of the parameters of the method. Method
`extractKey` is an example. Its result type, `k.key` refers its
parameter `k` (we also say, `k.Key` _depends_ on `k`). But so far it
was not possible to turn such methods into function values, so thay
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so that

they can be passed as parameters to other functions, or returned as
results. Dependent methods could not be turned into functions simply
because there was no type that could describe them.

In Dotty this is now made possible. The type of the `extractor` value above is

(k: Keyed) => k.Key

This type describes function values that take an argument `x` of type
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's k, not x (same on the next line)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, k is the parameter. I wanted to use a different name for the argument.

`Keyed` and return a result of type `x.Key`.

Recall that a normal function type `A => B` is represented as an
instance of the `Function1` trait (i.e. `Function1[A, B]`) and
analogously for functions with more parameters. Dependent functions
are also represented as instances of these traits, but they get an additional
refinement. In fact, the dependent function type above is just syntactic sugar for

Function1[Keyed, Keyed#Key] {
def apply(k: Keyed): k.Key
}

In general, a dependent functon type `(x1: K1, ..., xN: KN) => R` of arity `N`
translates to

FunctionN[K1, ..., Kn, R'] {
def apply(x1: K1, ..., xN: KN): R
}

where the result type parameter `R` is an upper approximation of the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

R'?

true result type `R` that does not mention any of the parameters `k1, ..., kN`.
2 changes: 2 additions & 0 deletions docs/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ sidebar:
url: docs/reference/type-lambdas.html
- title: Implicit Function Types
url: docs/reference/implicit-function-types.html
- title: Dependent Function Types
url: docs/reference/dependent-function-types.html
- title: Phantom Types
url: docs/reference/phantom-types.html
- title: Literal Singleton Types
Expand Down