Current section

Files

Jump to
cloudi_core doc cloudi_lists.html
Raw

doc/cloudi_lists.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Module cloudi_lists</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>
<h1>Module cloudi_lists</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<h3><a name="List_operations">List operations</a></h3>.
<p>Copyright © 2009-2020 Michael Truog</p>
<p><b>Version:</b> 2.0.1 Dec 3 2021 17:15:32
------------------------------------------------------------------------</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog at protonmail dot com"><tt>mjtruog at protonmail dot com</tt></a>).</p>
<h2><a name="description">Description</a></h2>
<h3><a name="List_operations">List operations</a></h3>
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#delete_all-2">delete_all/2</a></td><td>
<h4><a name="lists:delete/2_functionality,_but_all_instances_are_deleted.">lists:delete/2 functionality, but all instances are deleted.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#delete_checked-2">delete_checked/2</a></td><td>
<h4><a name="lists:delete/2_functionality,_but_returns_false_when_an_element_is_not_deleted.">lists:delete/2 functionality, but returns false when an element is not deleted.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#index-2">index/2</a></td><td>
<h4><a name="Find_the_index_of_the_first_occurrence_of_an_item_within_a_list.">Find the index of the first occurrence of an item within a list.</a></h4>
The integer index returned is 1-based.</td></tr>
<tr><td valign="top"><a href="#iodata_to_list-1">iodata_to_list/1</a></td><td>
<h4><a name="Convert_iodata_to_a_list_of_bytes_and_return_the_size_of_the_list.">Convert iodata to a list of bytes and return the size of the list.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#itera-3">itera/3</a></td><td>
<h4><a name="Iterate_on_elements_of_a_list_with_an_accumulator.">Iterate on elements of a list with an accumulator.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#itera2-4">itera2/4</a></td><td>
<h4><a name="Iterate_on_elements_of_a_list_with_two_accumulators.">Iterate on elements of a list with two accumulators.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#member_all-2">member_all/2</a></td><td>
<h4><a name="lists:member/2_functionality,_but_with_a_list_of_elements_where_all_must_be_present.">lists:member/2 functionality, but with a list of elements where all must be present.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#member_any-2">member_any/2</a></td><td>
<h4><a name="lists:member/2_functionality,_but_with_a_list_of_elements_where_one_must_be_present.">lists:member/2 functionality, but with a list of elements where one must be present.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#split-2">split/2</a></td><td>
<h4><a name="lists:split/2_functionality,_but_without_bounds_checking.">lists:split/2 functionality, but without bounds checking.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#take_values-2">take_values/2</a></td><td>
<h4><a name="cloudi_proplists:take_values/2_functionality,_but_with_any_tuple_list.">cloudi_proplists:take_values/2 functionality, but with any tuple list.</a></h4>.</td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="delete_all-2">delete_all/2</a></h3>
<div class="spec">
<p><tt>delete_all(Elem::any(), List::list()) -&gt; list()</tt><br></p>
<p> </p>
</div><p>
<h4><a name="lists:delete/2_functionality,_but_all_instances_are_deleted.">lists:delete/2 functionality, but all instances are deleted.</a></h4>
</p>
<h3 class="function"><a name="delete_checked-2">delete_checked/2</a></h3>
<div class="spec">
<p><tt>delete_checked(Elem::any(), List::list()) -&gt; list() | false</tt><br></p>
<p> </p>
</div><p>
<h4><a name="lists:delete/2_functionality,_but_returns_false_when_an_element_is_not_deleted.">lists:delete/2 functionality, but returns false when an element is not deleted.</a></h4>
</p>
<h3 class="function"><a name="index-2">index/2</a></h3>
<div class="spec">
<p><tt>index(Item::any(), L::list()) -&gt; undefined | pos_integer()</tt><br></p>
<p> </p>
</div><p>
<h4><a name="Find_the_index_of_the_first_occurrence_of_an_item_within_a_list.">Find the index of the first occurrence of an item within a list.</a></h4>
The integer index returned is 1-based.</p>
<h3 class="function"><a name="iodata_to_list-1">iodata_to_list/1</a></h3>
<div class="spec">
<p><tt>iodata_to_list(IOData::iodata()) -&gt; {Size::non_neg_integer(), Bytes::[byte()]}</tt><br></p>
<p> </p>
</div><p>
<h4><a name="Convert_iodata_to_a_list_of_bytes_and_return_the_size_of_the_list.">Convert iodata to a list of bytes and return the size of the list.</a></h4>
</p>
<h3 class="function"><a name="itera-3">itera/3</a></h3>
<div class="spec">
<p><tt>itera(F::fun((any(), any(), fun((any()) -&gt; any())) -&gt; any()), Acc::any(), T::list()) -&gt; any()</tt><br></p>
<p> </p>
</div><p>
<h4><a name="Iterate_on_elements_of_a_list_with_an_accumulator.">Iterate on elements of a list with an accumulator.</a></h4>
</p>
<h3 class="function"><a name="itera2-4">itera2/4</a></h3>
<div class="spec">
<p><tt>itera2(F::fun((any(), any(), any(), fun((any(), any()) -&gt; {any(), any()})) -&gt; {any(), any()}), Acc0::any(), Acc1::any(), T::list()) -&gt; {any(), any()}</tt><br></p>
<p> </p>
</div><p>
<h4><a name="Iterate_on_elements_of_a_list_with_two_accumulators.">Iterate on elements of a list with two accumulators.</a></h4>
</p>
<h3 class="function"><a name="member_all-2">member_all/2</a></h3>
<div class="spec">
<p><tt>member_all(ElemL::list(), List::list()) -&gt; boolean()</tt><br></p>
<p> </p>
</div><p>
<h4><a name="lists:member/2_functionality,_but_with_a_list_of_elements_where_all_must_be_present.">lists:member/2 functionality, but with a list of elements where all must be present.</a></h4>
</p>
<h3 class="function"><a name="member_any-2">member_any/2</a></h3>
<div class="spec">
<p><tt>member_any(ElemL::list(), List::list()) -&gt; boolean()</tt><br></p>
<p> </p>
</div><p>
<h4><a name="lists:member/2_functionality,_but_with_a_list_of_elements_where_one_must_be_present.">lists:member/2 functionality, but with a list of elements where one must be present.</a></h4>
</p>
<h3 class="function"><a name="split-2">split/2</a></h3>
<div class="spec">
<p><tt>split(N, L) -&gt; {L1, L2}</tt>
<ul class="definitions"><li><tt>N = non_neg_integer()</tt></li><li><tt>L = [E]</tt></li><li><tt>L1 = [E]</tt></li><li><tt>L2 = [E]</tt></li><li><tt>E = any()</tt></li></ul></p>
<p> </p>
</div><p>
<h4><a name="lists:split/2_functionality,_but_without_bounds_checking.">lists:split/2 functionality, but without bounds checking.</a></h4>
</p>
<h3 class="function"><a name="take_values-2">take_values/2</a></h3>
<div class="spec">
<p><tt>take_values(DefaultList::[{any(), any()}], List::[{any(), any()}]) -&gt; list()</tt><br></p>
<p> </p>
</div><p>
<h4><a name="cloudi_proplists:take_values/2_functionality,_but_with_any_tuple_list.">cloudi_proplists:take_values/2 functionality, but with any tuple list.</a></h4>
</p>
<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc</i></p>
</body>
</html>