File: erl_internal.html

package info (click to toggle)
erlang-doc-html 1%3A11.b.2-1
links: PTS
area: main
in suites: etch, etch-m68k
size: 23,284 kB
ctags: 10,724
sloc: erlang: 505; ansic: 323; makefile: 62; perl: 61; sh: 45
file content (225 lines) | stat: -rw-r--r-- 5,264 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>erl_internal</TITLE>
  <SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
  <STYLE TYPE="text/css">
<!--
    .REFBODY     { margin-left: 13mm }
    .REFTYPES    { margin-left: 8mm }
-->
  </STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
      ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
  <IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>erl_internal</H1>
</CENTER>

<H3>MODULE</H3>
<DIV CLASS=REFBODY>
erl_internal
</DIV>

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
Internal Erlang Definitions
</DIV>

<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>

<P>This module defines Erlang BIFs, guard tests and operators.
This module is only of interest to programmers who
manipulate Erlang code.

</DIV>

<H3>EXPORTS</H3>

<P><A NAME="bif/2"><STRONG><CODE>bif(Name, Arity) -&#62; bool()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Name = atom()</CODE></STRONG><BR>
<STRONG><CODE>Arity = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Returns <CODE>true</CODE> if <CODE>Name/Arity</CODE> is an Erlang BIF
         which is automatically recognized by the compiler, otherwise
         <CODE>false</CODE>.

</DIV>

<P><A NAME="guard_bif/2"><STRONG><CODE>guard_bif(Name, Arity) -&#62; bool()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Name = atom()</CODE></STRONG><BR>
<STRONG><CODE>Arity = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Returns <CODE>true</CODE> if <CODE>Name/Arity</CODE> is an Erlang BIF
         which is allowed in guards, otherwise <CODE>false</CODE>.

</DIV>

<P><A NAME="type_test/2"><STRONG><CODE>type_test(Name, Arity) -&#62; bool()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Name = atom()</CODE></STRONG><BR>
<STRONG><CODE>Arity = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Returns <CODE>true</CODE> if <CODE>Name/Arity</CODE> is a valid Erlang
         type test, otherwise <CODE>false</CODE>.

</DIV>

<P><A NAME="arith_op/2"><STRONG><CODE>arith_op(OpName, Arity) -&#62; bool()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>OpName = atom()</CODE></STRONG><BR>
<STRONG><CODE>Arity = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Returns <CODE>true</CODE> if <CODE>OpName/Arity</CODE> is an arithmetic
         operator, otherwise <CODE>false</CODE>.

</DIV>

<P><A NAME="bool_op/2"><STRONG><CODE>bool_op(OpName, Arity) -&#62; bool()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>OpName = atom()</CODE></STRONG><BR>
<STRONG><CODE>Arity = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Returns <CODE>true</CODE> if <CODE>OpName/Arity</CODE> is a Boolean
         operator, otherwise <CODE>false</CODE>.

</DIV>

<P><A NAME="comp_op/2"><STRONG><CODE>comp_op(OpName, Arity) -&#62; bool()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>OpName = atom()</CODE></STRONG><BR>
<STRONG><CODE>Arity = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Returns <CODE>true</CODE> if <CODE>OpName/Arity</CODE> is a comparison
         operator, otherwise <CODE>false</CODE>.

</DIV>

<P><A NAME="list_op/2"><STRONG><CODE>list_op(OpName, Arity) -&#62; bool()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>OpName = atom()</CODE></STRONG><BR>
<STRONG><CODE>Arity = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Returns <CODE>true</CODE> if <CODE>OpName/Arity</CODE> is a list
         operator, otherwise <CODE>false</CODE>.

</DIV>

<P><A NAME="send_op/2"><STRONG><CODE>send_op(OpName, Arity) -&#62; bool()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>OpName = atom()</CODE></STRONG><BR>
<STRONG><CODE>Arity = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Returns <CODE>true</CODE> if <CODE>OpName/Arity</CODE> is a send
         operator, otherwise <CODE>false</CODE>.

</DIV>

<P><A NAME="op_type/2"><STRONG><CODE>op_type(OpName, Arity) -&#62; Type</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>OpName = atom()</CODE></STRONG><BR>
<STRONG><CODE>Arity = integer()</CODE></STRONG><BR>
<STRONG><CODE>Type = arith | bool | comp | list | send</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Returns the <CODE>Type</CODE> of operator that <CODE>OpName/Arity</CODE> 
         belongs to, 
         or generates a <CODE>function_clause</CODE> error if it is not an 
         operator at all.

</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Robert Virding - support@erlang.ericsson.se<BR>

</DIV>
<CENTER>
<HR>
<SMALL>stdlib 1.14.2<BR>
Copyright &copy; 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>