ligo/gitlab-pages/docs/language-basics/functions.md

124 lines
3.3 KiB
Markdown
Raw Normal View History

2019-06-11 05:37:12 +04:00
---
id: functions
title: Functions
---
Writing code is fun as long as it doesn't get out of hand. To make sure our code doesn't turn into spaghetti we can group some logic into functions.
## Instruction blocks
2019-06-11 05:37:12 +04:00
With `block`(s) you can wrap *instructions* and *expressions* into an isolated scope.
Each `block` needs to include at least one `instruction`, or a *placeholder* instruction called `skip`.
2019-06-11 05:37:12 +04:00
<!--DOCUSAURUS_CODE_TABS-->
<!--Pascaligo-->
2019-12-26 15:51:42 +04:00
```pascaligo skip
// shorthand syntax
block { skip }
// verbose syntax
begin
skip
end
2019-06-11 05:37:12 +04:00
```
<!--END_DOCUSAURUS_CODE_TABS-->
## Defining a function
2019-06-11 05:37:12 +04:00
<!--DOCUSAURUS_CODE_TABS-->
<!--Pascaligo-->
Functions in PascaLIGO are defined using the `function` keyword followed by their `name`, `parameters` and `return` type definitions.
Here's how you define a basic function that accepts two `ints` and returns a single `int`:
2019-12-26 15:51:42 +04:00
```pascaligo group=a
function add(const a: int; const b: int): int is
begin
const result: int = a + b;
end with result;
```
The function body consists of two parts:
- `block {<code>}` - logic of the function
- `with <value>` - the return value of the function
#### Blockless functions
Functions that can contain all of their logic into a single instruction/expression, can be defined without the surrounding `block`.
Instead, you can inline the necessary logic directly, like this:
2019-12-26 15:51:42 +04:00
```pascaligo group=b
function add(const a: int; const b: int): int is a + b
```
2019-06-11 05:37:12 +04:00
<!--CameLIGO-->
2019-06-11 05:37:12 +04:00
Functions in CameLIGO are defined using the `let` keyword, like value bindings.
The difference is that after the value name a list of function parameters is provided,
along with a return type.
Here's how you define a basic function that accepts two `ints` and returns an `int` as well:
2019-12-26 15:51:42 +04:00
```cameligo group=b
let add (a: int) (b: int) : int = a + b
2019-06-11 05:37:12 +04:00
```
The function body is a series of expressions, which are evaluated to give the return
value.
2019-12-11 13:34:08 +04:00
<!--ReasonLIGO-->
Functions in ReasonLIGO are defined using the `let` keyword, like value bindings.
The difference is that after the value name a list of function parameters is provided,
along with a return type.
Here's how you define a basic function that accepts two `ints` and returns an `int` as well:
2019-12-26 15:51:42 +04:00
```reasonligo group=b
let add = (a: int, b: int) : int => a + b;
2019-12-11 13:34:08 +04:00
```
The function body is a series of expressions, which are evaluated to give the return
value.
<!--END_DOCUSAURUS_CODE_TABS-->
<!--DOCUSAURUS_CODE_TABS-->
<!--Pascaligo-->
2019-12-26 15:51:42 +04:00
```pascaligo group=b
const increment : (int -> int) = (function (const i : int) : int is i + 1);
// a = 2
const a: int = increment(1);
```
<!--END_DOCUSAURUS_CODE_TABS-->
## Anonymous functions
Functions without a name, also known as anonymous functions are useful in cases when you want to pass the function as an argument or assign it to a key in a record/map.
Here's how to define an anonymous function assigned to a variable `increment`, with it's appropriate function type signature.
<!--DOCUSAURUS_CODE_TABS-->
<!--Pascaligo-->
2019-12-26 15:51:42 +04:00
```pascaligo group=c
const increment : (int -> int) = (function (const i : int) : int is i + 1);
// a = 2
const a: int = increment(1);
```
<!--CameLIGO-->
2019-12-26 15:51:42 +04:00
```cameligo group=c
let increment : (int -> int) = fun (i: int) -> i + 1
```
2019-12-11 13:34:08 +04:00
<!--ReasonLIGO-->
2019-12-26 15:51:42 +04:00
```reasonligo group=c
2019-12-10 17:47:31 +04:00
let increment: (int => int) = (i: int) => i + 1;
```
<!--END_DOCUSAURUS_CODE_TABS-->