hxt-8.0.0: doc/hdoc/src/Data-Tree-Class.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>Haskell Code by HsColour</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='comment'>{- |
<a name="line-4"></a> Module : Data.Tree.Class
<a name="line-5"></a> Copyright : Copyright (C) 2005 Uwe Schmidt
<a name="line-6"></a> License : MIT
<a name="line-7"></a>
<a name="line-8"></a> Maintainer : Uwe Schmidt (uwe\@fh-wedel.de)
<a name="line-9"></a> Stability : experimental
<a name="line-10"></a> Portability: portable
<a name="line-11"></a>
<a name="line-12"></a> Interface definition for trees
<a name="line-13"></a>-}</span>
<a name="line-14"></a>
<a name="line-15"></a><span class='comment'>-- ------------------------------------------------------------</span>
<a name="line-16"></a>
<a name="line-17"></a><span class='keyword'>module</span> <span class='conid'>Data</span><span class='varop'>.</span><span class='conid'>Tree</span><span class='varop'>.</span><span class='conid'>Class</span>
<a name="line-18"></a> <span class='layout'>(</span> <span class='keyword'>module</span> <span class='conid'>Data</span><span class='varop'>.</span><span class='conid'>Tree</span><span class='varop'>.</span><span class='conid'>Class</span> <span class='layout'>)</span>
<a name="line-19"></a><span class='keyword'>where</span>
<a name="line-20"></a>
<a name="line-21"></a><span class='comment'>-- | The interface for trees</span>
<a name="line-22"></a>
<a name="line-23"></a><a name="Tree"></a><span class='keyword'>class</span> <span class='conid'>Tree</span> <span class='varid'>t</span> <span class='keyword'>where</span>
<a name="line-24"></a> <span class='comment'>-- | tree construction: a new tree is constructed by a node attribute and a list of children</span>
<a name="line-25"></a> <span class='varid'>mkTree</span> <span class='keyglyph'>::</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='keyglyph'>[</span><span class='varid'>t</span> <span class='varid'>a</span><span class='keyglyph'>]</span> <span class='keyglyph'>-></span> <span class='varid'>t</span> <span class='varid'>a</span>
<a name="line-26"></a>
<a name="line-27"></a> <span class='comment'>-- | leaf construction: leafs don't have any children</span>
<a name="line-28"></a> <span class='comment'>--</span>
<a name="line-29"></a> <span class='comment'>-- definition: @ mkLeaf n = mkTree n [] @</span>
<a name="line-30"></a>
<a name="line-31"></a> <span class='varid'>mkLeaf</span> <span class='keyglyph'>::</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='varid'>t</span> <span class='varid'>a</span>
<a name="line-32"></a> <span class='varid'>mkLeaf</span> <span class='varid'>n</span> <span class='keyglyph'>=</span> <span class='varid'>mkTree</span> <span class='varid'>n</span> <span class='conid'>[]</span>
<a name="line-33"></a>
<a name="line-34"></a> <span class='comment'>-- | leaf test: list of children empty?</span>
<a name="line-35"></a>
<a name="line-36"></a> <span class='varid'>isLeaf</span> <span class='keyglyph'>::</span> <span class='varid'>t</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='conid'>Bool</span>
<a name="line-37"></a> <span class='varid'>isLeaf</span> <span class='keyglyph'>=</span> <span class='varid'>null</span> <span class='varop'>.</span> <span class='varid'>getChildren</span>
<a name="line-38"></a>
<a name="line-39"></a> <span class='comment'>-- | innner node test: @ not . isLeaf @</span>
<a name="line-40"></a>
<a name="line-41"></a> <span class='varid'>isInner</span> <span class='keyglyph'>::</span> <span class='varid'>t</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='conid'>Bool</span>
<a name="line-42"></a> <span class='varid'>isInner</span> <span class='keyglyph'>=</span> <span class='varid'>not</span> <span class='varop'>.</span> <span class='varid'>isLeaf</span>
<a name="line-43"></a>
<a name="line-44"></a> <span class='comment'>-- | select node attribute</span>
<a name="line-45"></a>
<a name="line-46"></a> <span class='varid'>getNode</span> <span class='keyglyph'>::</span> <span class='varid'>t</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='varid'>a</span>
<a name="line-47"></a>
<a name="line-48"></a> <span class='comment'>-- | select children</span>
<a name="line-49"></a>
<a name="line-50"></a> <span class='varid'>getChildren</span> <span class='keyglyph'>::</span> <span class='varid'>t</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='keyglyph'>[</span><span class='varid'>t</span> <span class='varid'>a</span><span class='keyglyph'>]</span>
<a name="line-51"></a>
<a name="line-52"></a> <span class='comment'>-- | edit node attribute</span>
<a name="line-53"></a>
<a name="line-54"></a> <span class='varid'>changeNode</span> <span class='keyglyph'>::</span> <span class='layout'>(</span><span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='varid'>a</span><span class='layout'>)</span> <span class='keyglyph'>-></span> <span class='varid'>t</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='varid'>t</span> <span class='varid'>a</span>
<a name="line-55"></a>
<a name="line-56"></a> <span class='comment'>-- | edit children</span>
<a name="line-57"></a>
<a name="line-58"></a> <span class='varid'>changeChildren</span> <span class='keyglyph'>::</span> <span class='layout'>(</span><span class='keyglyph'>[</span><span class='varid'>t</span> <span class='varid'>a</span><span class='keyglyph'>]</span> <span class='keyglyph'>-></span> <span class='keyglyph'>[</span><span class='varid'>t</span> <span class='varid'>a</span><span class='keyglyph'>]</span><span class='layout'>)</span> <span class='keyglyph'>-></span> <span class='varid'>t</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='varid'>t</span> <span class='varid'>a</span>
<a name="line-59"></a>
<a name="line-60"></a> <span class='comment'>-- | substitute node: @ setNode n = changeNode (const n) @</span>
<a name="line-61"></a>
<a name="line-62"></a> <span class='varid'>setNode</span> <span class='keyglyph'>::</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='varid'>t</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='varid'>t</span> <span class='varid'>a</span>
<a name="line-63"></a> <span class='varid'>setNode</span> <span class='varid'>n</span> <span class='keyglyph'>=</span> <span class='varid'>changeNode</span> <span class='layout'>(</span><span class='varid'>const</span> <span class='varid'>n</span><span class='layout'>)</span>
<a name="line-64"></a>
<a name="line-65"></a> <span class='comment'>-- | substitute children: @ setChildren cl = changeChildren (const cl) @</span>
<a name="line-66"></a>
<a name="line-67"></a> <span class='varid'>setChildren</span> <span class='keyglyph'>::</span> <span class='keyglyph'>[</span><span class='varid'>t</span> <span class='varid'>a</span><span class='keyglyph'>]</span> <span class='keyglyph'>-></span> <span class='varid'>t</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='varid'>t</span> <span class='varid'>a</span>
<a name="line-68"></a> <span class='varid'>setChildren</span> <span class='varid'>cl</span> <span class='keyglyph'>=</span> <span class='varid'>changeChildren</span> <span class='layout'>(</span><span class='varid'>const</span> <span class='varid'>cl</span><span class='layout'>)</span>
<a name="line-69"></a>
<a name="line-70"></a> <span class='comment'>-- | fold for trees</span>
<a name="line-71"></a>
<a name="line-72"></a> <span class='varid'>foldTree</span> <span class='keyglyph'>::</span> <span class='layout'>(</span><span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='keyglyph'>[</span><span class='varid'>b</span><span class='keyglyph'>]</span> <span class='keyglyph'>-></span> <span class='varid'>b</span><span class='layout'>)</span> <span class='keyglyph'>-></span> <span class='varid'>t</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='varid'>b</span>
<a name="line-73"></a>
<a name="line-74"></a> <span class='comment'>-- | all nodes of a tree</span>
<a name="line-75"></a>
<a name="line-76"></a> <span class='varid'>nodesTree</span> <span class='keyglyph'>::</span> <span class='varid'>t</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='keyglyph'>[</span><span class='varid'>a</span><span class='keyglyph'>]</span>
<a name="line-77"></a>
<a name="line-78"></a> <span class='comment'>-- | depth of a tree</span>
<a name="line-79"></a>
<a name="line-80"></a> <span class='varid'>depthTree</span> <span class='keyglyph'>::</span> <span class='varid'>t</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='conid'>Int</span>
<a name="line-81"></a>
<a name="line-82"></a> <span class='comment'>-- | number of nodes in a tree</span>
<a name="line-83"></a>
<a name="line-84"></a> <span class='varid'>cardTree</span> <span class='keyglyph'>::</span> <span class='varid'>t</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='conid'>Int</span>
<a name="line-85"></a>
<a name="line-86"></a> <span class='comment'>-- | format tree for readable trace output</span>
<a name="line-87"></a> <span class='comment'>--</span>
<a name="line-88"></a> <span class='comment'>-- a /graphical/ representation of the tree in text format</span>
<a name="line-89"></a>
<a name="line-90"></a> <span class='varid'>formatTree</span> <span class='keyglyph'>::</span> <span class='layout'>(</span><span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='conid'>String</span><span class='layout'>)</span> <span class='keyglyph'>-></span> <span class='varid'>t</span> <span class='varid'>a</span> <span class='keyglyph'>-></span> <span class='conid'>String</span>
<a name="line-91"></a>
<a name="line-92"></a><span class='comment'>-- ------------------------------------------------------------</span>
</pre></body>
</html>