You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2 lines
7.8 KiB

This file contains invisible Unicode characters!

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Models (infer.InferModules.Models)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> &mdash; <span class="package">package <a href="../../index.html">infer</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">InferModules.Models</span></h1></header><div class="spec module" id="module-Hashtbl"><a href="#module-Hashtbl" class="anchor"></a><div class="def module"><code><span class="keyword">module </span>Hashtbl = <a href="../../../InferStdlib/InferStdlib/index.html#module-IStd">InferStdlib.IStd</a>.Caml.Hashtbl</code></div><div class="doc"></div></div><div class="spec module" id="module-L"><a href="#module-L" class="anchor"></a><div class="def module"><code><span class="keyword">module </span>L = <a href="../../../InferBase/InferBase/index.html#module-Logging">InferBase.Logging</a></code></div><div class="doc"></div></div><p>Module for standard library models.</p><div class="spec val" id="val-use_models"><a href="#val-use_models" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>use_models : bool</code></div><div class="doc"></div></div><div class="spec module" id="module-Inference"><a href="#module-Inference" class="anchor"></a><div class="def module"><code><span class="keyword">module </span><a href="Inference/index.html">Inference</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="doc"><p>Module for inference of parameter and return annotations.</p></div></div><div class="spec val" id="val-match_method_name"><a href="#val-match_method_name" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>match_method_name : <a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a> <span class="keyword">&#8209;&gt;</span> <a href="../../../InferStdlib/InferStdlib/index.html#module-IStd">InferStdlib.IStd</a>.String.t <span class="keyword">&#8209;&gt;</span> bool</code></div><div class="doc"></div></div><div class="spec val" id="val-table_has_procedure"><a href="#val-table_has_procedure" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>table_has_procedure : (string, <span class="type-var">'a</span>) <a href="index.html#module-Hashtbl">Hashtbl</a>.t <span class="keyword">&#8209;&gt;</span> <a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a> <span class="keyword">&#8209;&gt;</span> bool</code></div><div class="doc"></div></div><div class="spec val" id="val-get_modelled_annotated_signature"><a href="#val-get_modelled_annotated_signature" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_modelled_annotated_signature : <a href="../../../InferIR/InferIR/ProcAttributes/index.html#type-t">InferIR.ProcAttributes.t</a> <span class="keyword">&#8209;&gt;</span> <a href="../AnnotatedSignature/index.html#type-t">AnnotatedSignature.t</a></code></div><div class="doc"><p>Return the annotated signature of the procedure, taking into account models.</p></div></div><div class="spec val" id="val-is_modelled_nullable"><a href="#val-is_modelled_nullable" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>is_modelled_nullable : <a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a> <span class="keyword">&#8209;&gt;</span> bool</code></div><div class="doc"><p>Return true when the procedure has been modelled for nullable.</p></div></div><div class="spec val" id="val-is_check_not_null"><a href="#val-is_check_not_null" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>is_check_not_null : <a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a> <span class="keyword">&#8209;&gt;</span> bool</code></div><div class="doc"><p>Check if the procedure is one of the known Preconditions.checkNotNull.</p></div></div><div class="spec val" id="val-get_check_not_null_parameter"><a href="#val-get_check_not_null_parameter" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_check_not_null_parameter : <a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a> <span class="keyword">&#8209;&gt;</span> int</code></div><div class="doc"><p>Parameter number for a procedure known to be a checkNotNull</p></div></div><div class="spec val" id="val-is_check_state"><a href="#val-is_check_state" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>is_check_state : <a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a> <span class="keyword">&#8209;&gt;</span> bool</code></div><div class="doc"><p>Check if the procedure is one of the known Preconditions.checkState.</p></div></div><div class="spec val" id="val-is_check_argument"><a href="#val-is_check_argument" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>is_check_argument : <a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a> <span class="keyword">&#8209;&gt;</span> bool</code></div><div class="doc"><p>Check if the procedure is one of the known Preconditions.checkArgument.</p></div></div><div class="spec val" id="val-is_noreturn"><a href="#val-is_noreturn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>is_noreturn : <a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a> <span class="keyword">&#8209;&gt;</span> bool</code></div><div class="doc"><p>Check if the procedure does not return.</p></div></div><div class="spec val" id="val-is_optional_get"><a href="#val-is_optional_get" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>is_optional_get : <a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a> <span class="keyword">&#8209;&gt;</span> bool</code></div><div class="doc"><p>Check if the procedure is Optional.get().</p></div></div><div class="spec val" id="val-is_optional_isPresent"><a href="#val-is_optional_isPresent" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>is_optional_isPresent : <a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a> <span class="keyword">&#8209;&gt;</span> bool</code></div><div class="doc"><p>Check if the procedure is Optional.isPresent().</p></div></div><div class="spec val" id="val-is_true_on_null"><a href="#val-is_true_on_null" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>is_true_on_null : <a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a> <span class="keyword">&#8209;&gt;</span> bool</code></div><div class="doc"><p>Check if the procedure returns true on null.</p></div></div><div class="spec val" id="val-is_containsKey"><a href="#val-is_containsKey" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>is_containsKey : <a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a> <span class="keyword">&#8209;&gt;</span> bool</code></div><div class="doc"><p>Check if the procedure is Map.containsKey().</p></div></div><div class="spec val" id="val-is_mapPut"><a href="#val-is_mapPut" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>is_mapPut : <a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a> <span class="keyword">&#8209;&gt;</span> bool</code></div><div class="doc"><p>Check if the procedure is Map.put().</p></div></div></body></html>