File: erl_internal.3

package info (click to toggle)
erlang-manpages 1%3A12.b.3-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,188 kB
  • ctags: 2
  • sloc: makefile: 68; perl: 30; sh: 15
file content (154 lines) | stat: -rw-r--r-- 2,309 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
.TH erl_internal 3 "stdlib  1.15.3" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
erl_internal \- Internal Erlang Definitions
.SH DESCRIPTION
.LP
This module defines Erlang BIFs, guard tests and operators\&. This module is only of interest to programmers who manipulate Erlang code\&.

.SH EXPORTS
.LP
.B
bif(Name, Arity) -> bool()
.br
.RS
.TP
Types
Name = atom()
.br
Arity = integer()
.br
.RE
.RS
.LP
Returns \fItrue\fR if \fIName/Arity\fR is an Erlang BIF which is automatically recognized by the compiler, otherwise \fIfalse\fR\&.
.RE
.LP
.B
guard_bif(Name, Arity) -> bool()
.br
.RS
.TP
Types
Name = atom()
.br
Arity = integer()
.br
.RE
.RS
.LP
Returns \fItrue\fR if \fIName/Arity\fR is an Erlang BIF which is allowed in guards, otherwise \fIfalse\fR\&.
.RE
.LP
.B
type_test(Name, Arity) -> bool()
.br
.RS
.TP
Types
Name = atom()
.br
Arity = integer()
.br
.RE
.RS
.LP
Returns \fItrue\fR if \fIName/Arity\fR is a valid Erlang type test, otherwise \fIfalse\fR\&.
.RE
.LP
.B
arith_op(OpName, Arity) -> bool()
.br
.RS
.TP
Types
OpName = atom()
.br
Arity = integer()
.br
.RE
.RS
.LP
Returns \fItrue\fR if \fIOpName/Arity\fR is an arithmetic operator, otherwise \fIfalse\fR\&.
.RE
.LP
.B
bool_op(OpName, Arity) -> bool()
.br
.RS
.TP
Types
OpName = atom()
.br
Arity = integer()
.br
.RE
.RS
.LP
Returns \fItrue\fR if \fIOpName/Arity\fR is a Boolean operator, otherwise \fIfalse\fR\&.
.RE
.LP
.B
comp_op(OpName, Arity) -> bool()
.br
.RS
.TP
Types
OpName = atom()
.br
Arity = integer()
.br
.RE
.RS
.LP
Returns \fItrue\fR if \fIOpName/Arity\fR is a comparison operator, otherwise \fIfalse\fR\&.
.RE
.LP
.B
list_op(OpName, Arity) -> bool()
.br
.RS
.TP
Types
OpName = atom()
.br
Arity = integer()
.br
.RE
.RS
.LP
Returns \fItrue\fR if \fIOpName/Arity\fR is a list operator, otherwise \fIfalse\fR\&.
.RE
.LP
.B
send_op(OpName, Arity) -> bool()
.br
.RS
.TP
Types
OpName = atom()
.br
Arity = integer()
.br
.RE
.RS
.LP
Returns \fItrue\fR if \fIOpName/Arity\fR is a send operator, otherwise \fIfalse\fR\&.
.RE
.LP
.B
op_type(OpName, Arity) -> Type
.br
.RS
.TP
Types
OpName = atom()
.br
Arity = integer()
.br
Type = arith | bool | comp | list | send
.br
.RE
.RS
.LP
Returns the \fIType\fR of operator that \fIOpName/Arity\fR belongs to, or generates a \fIfunction_clause\fR error if it is not an operator at all\&.
.RE