# 関数

[![badge](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com%2Fdefault%2Fsource_up_to_date%3Fowner%3Derg-lang%26repos%3Derg%26ref%3Dmain%26path%3Ddoc/EN/API/funcs.md%26commit_hash%3D)](https://gezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com/default/source_up_to_date?owner=erg-lang&repos=erg&ref=main&path=doc/EN/API/funcs.md&commit_hash=)

> __Note__: `match`は関数ではなく特殊形式です。

## 基本関数

### if|T, U|(cond: Bool, then: T, else: U := NoneType) -> T or U

### map|T, U|(i: Iterable T, f: T -> U) -> Map U

Pythonとは引数の順番が逆なので注意。

### log(x: Object, type: LogType = Info) -> None

`x`をデバッグ表示でログに残す。ログは、実行が終了した後にまとめて表示される。
絵文字対応ターミナルでは`type`に応じてプレフィックスがつく。

* type == Info: 💬
* type == Ok: ✅
* type == Warn: ⚠️
* type == Hint: 💡

### panic(msg: Str) -> Panic

msgを表示して停止する。
絵文字対応ターミナルでは🚨がプレフィックスに付く。

### discard|T|(*x: T) -> NoneType

`x`を捨てる。戻り値を使用しないときなどに使う。`Del`とは違い、変数`x`を参照できなくするわけではない。

```python
p! x =
    # q!は何らかのNoneや()でない値を返すとする
    # 要らない場合は`discard`を使う
    discard q!(x)
    f x

discard True
assert True # OK
```

### import(path: Path) -> Module or CompilerPanic

モジュールをインポートする。モジュールが見つからない場合、コンパイルエラーを送出する。

### eval(code: Str) -> Object

codeをコードとして評価し返す。

### classof(object: Object) -> Class

`object`のクラスを返す。
ただしクラスは比較できないため、インスタンス判定がしたい場合は`classof(object) == Class`ではなく`object in Class`を使う。
コンパイル時に決定される構造型は`Typeof`で得られる。

## Iterator, List生成系

### repeat|T|(x: T) -> RepeatIterator T

```python
rep = repeat 1 # Repeater(1)
for! rep, i =>
    print! i
# 1 1 1 1 1 ...
```

### dup|T, N|(x: T, N: Nat) -> [T; N]

```python
[a, b, c] = dup new(), 3
print! a # <Object object>
print! a == b # False
```

### cycle|T|(it: Iterable T) -> CycleIterator T

```python
cycle([0, 1]).take 4 # [0, 1, 0, 1]
cycle("hello").take 3 # "hellohellohello"
```

## 定数式関数

### Class

クラスを新しく生成する。`Inherit`とは違い、`Class`を通すと基底型(第一引数`Base`)からは独立し、メソッドは失われる。
比較もできなくなるが、パターンマッチなどは行える。

```python
C = Class {i = Int}
NewInt = Class Int
Months = Class 1..12
jan = Months.new(1)
jan + Months.new(2) # TypeError: `+` is not implemented for 'Months'
match jan:
    1 -> log "January"
    _ -> log "Other"
```

### Inherit

クラスを継承する。親クラス(`Super`)のメソッドをそのまま使用できる。第二引数`Layout`に新しいレイアウトを指定できる。
この際、`Super.Base :> Layout`でなければならない。

```python
@Inheritable
C = Class {i = Int}
D = Inherit C, {i = Int; j = Int} # C.Layout == {i = Int} :> {i = Int; j = Int}
E! = Inherit C, {i = Int!} # {i = Int} :> {i = Int!}
```

### Trait

トレイトを新しく生成する。現在のところ、指定できるのはレコード型のみ。

### Typeof

引数の型を返す。実行時のクラスを得たい場合は`classof`を使う。
型指定に使うとWarningが出る。

```python,compile_warn
x: Typeof i = ...
# TypeWarning: Typeof(i) == Int, please replace it
```

### Deprecated

デコレータとして使用する。型や関数が非推奨であると警告する。