<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Bio.listfns</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Bio-module.html">Package Bio</a> ::
Module listfns
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Bio.listfns-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module listfns</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.listfns-pysrc.html">source code</a></span></p>
<p>This provides useful general functions for working with lists.</p>
<p>Functions: asdict Make the list into a dictionary (for fast
testing of membership). items Get one of each item in a list.
count Count the number of times each item appears. contents
Calculate percentage each item appears in a list. itemindex Make an
index of the items in the list. intersection Get the items in common
between 2 lists. difference Get the items in 1 list, but not the
other. indexesof Get a list of the indexes of some items in a list.
take Take some items from a list.</p>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dictionary</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Bio.listfns-module.html#asdict" class="summary-sig-name">asdict</a>(<span class="summary-sig-arg">l</span>)</span><br />
Return a dictionary where the keys are the items in the list, with
arbitrary values.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.listfns-pysrc.html#asdict">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of items</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Bio.listfns-module.html#items" class="summary-sig-name">items</a>(<span class="summary-sig-arg">l</span>)</span><br />
Generate a list of one of each item in l.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.listfns-pysrc.html#items">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict of counts of each item</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="count"></a><span class="summary-sig-name">count</span>(<span class="summary-sig-arg">items</span>)</span><br />
Count the number of times each item appears in a list of data.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.listfns-pysrc.html#count">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict of item:percentage</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Bio.listfns-module.html#contents" class="summary-sig-name">contents</a>(<span class="summary-sig-arg">items</span>)</span><br />
Summarize the contents of the list in terms of the percentages of
each item.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.listfns-pysrc.html#contents">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of common items</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Bio.listfns-module.html#intersection" class="summary-sig-name">intersection</a>(<span class="summary-sig-arg">l1</span>,
<span class="summary-sig-arg">l2</span>)</span><br />
Return a list of the items in both l1 and l2.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.listfns-pysrc.html#intersection">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of items in l1, but not l2</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Bio.listfns-module.html#difference" class="summary-sig-name">difference</a>(<span class="summary-sig-arg">l1</span>,
<span class="summary-sig-arg">l2</span>)</span><br />
Return a list of the items in l1, but not l2.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.listfns-pysrc.html#difference">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict of item : index of item</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Bio.listfns-module.html#itemindex" class="summary-sig-name">itemindex</a>(<span class="summary-sig-arg">l</span>)</span><br />
Make an index of the items in the list.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.listfns-pysrc.html#itemindex">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of indexes</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="indexesof"></a><span class="summary-sig-name">indexesof</span>(<span class="summary-sig-arg">l</span>,
<span class="summary-sig-arg">fn</span>)</span><br />
Return a list of indexes i where fn(l[i]) is true.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.listfns-pysrc.html#indexesof">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of just the indexes from l</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="take"></a><span class="summary-sig-name">take</span>(<span class="summary-sig-arg">l</span>,
<span class="summary-sig-arg">indexes</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.listfns-pysrc.html#take">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="take_byfn"></a><span class="summary-sig-name">take_byfn</span>(<span class="summary-sig-arg">l</span>,
<span class="summary-sig-arg">fn</span>,
<span class="summary-sig-arg">opposite</span>=<span class="summary-sig-default">0</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.listfns-pysrc.html#take_byfn">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="asdict"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">asdict</span>(<span class="sig-arg">l</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.listfns-pysrc.html#asdict">source code</a></span>
</td>
</tr></table>
<p>Return a dictionary where the keys are the items in the list, with
arbitrary values. This is useful for quick testing of membership.</p>
<dl class="fields">
<dt>Returns: dictionary</dt>
</dl>
</td></tr></table>
</div>
<a name="items"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">items</span>(<span class="sig-arg">l</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.listfns-pysrc.html#items">source code</a></span>
</td>
</tr></table>
<p>Generate a list of one of each item in l. The items are returned in
arbitrary order.</p>
<dl class="fields">
<dt>Returns: list of items</dt>
</dl>
</td></tr></table>
</div>
<a name="contents"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">contents</span>(<span class="sig-arg">items</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.listfns-pysrc.html#contents">source code</a></span>
</td>
</tr></table>
<p>Summarize the contents of the list in terms of the percentages of each
item. For example, if an item appears 3 times in a list with 10 items,
it is in 0.3 of the list.</p>
<dl class="fields">
<dt>Returns: dict of item:percentage</dt>
</dl>
</td></tr></table>
</div>
<a name="intersection"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">intersection</span>(<span class="sig-arg">l1</span>,
<span class="sig-arg">l2</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.listfns-pysrc.html#intersection">source code</a></span>
</td>
</tr></table>
<p>Return a list of the items in both l1 and l2. The list is in
arbitrary order.</p>
<dl class="fields">
<dt>Returns: list of common items</dt>
</dl>
</td></tr></table>
</div>
<a name="difference"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">difference</span>(<span class="sig-arg">l1</span>,
<span class="sig-arg">l2</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.listfns-pysrc.html#difference">source code</a></span>
</td>
</tr></table>
<p>Return a list of the items in l1, but not l2. The list is in
arbitrary order.</p>
<dl class="fields">
<dt>Returns: list of items in l1, but not l2</dt>
</dl>
</td></tr></table>
</div>
<a name="itemindex"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">itemindex</span>(<span class="sig-arg">l</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.listfns-pysrc.html#itemindex">source code</a></span>
</td>
</tr></table>
<p>Make an index of the items in the list. The dictionary contains the
items in the list as the keys, and the index of the first occurrence of
the item as the value.</p>
<dl class="fields">
<dt>Returns: dict of item : index of item</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon Sep 15 09:26:29 2008
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
