Skip to content

Commit

Permalink
Deploying to gh-pages from @ 226db00 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@mljs-bot
mljs-bot committed Feb 13, 2024
1 parent a3928a8 commit 8d5d60c
Showing 1 changed file with 119 additions and 6 deletions.
125 changes: 119 additions & 6 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset='utf-8'>
<title>ml-tree-similarity 2.0.0 | Documentation</title>
<title>ml-tree-similarity 2.1.0 | Documentation</title>
<meta name='description' content='Compares two spectra using a tree similarity'>
<meta name='viewport' content='width=device-width,initial-scale=1'>
<link href='assets/bass.css' rel='stylesheet'>
Expand All @@ -15,7 +15,7 @@
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
<div class='py1 px2'>
<h3 class='mb0 no-anchor'>ml-tree-similarity</h3>
<div class='mb1'><code>2.0.0</code></div>
<div class='mb1'><code>2.1.0</code></div>
<input
placeholder='Filter'
id='filter-input'
Expand All @@ -28,6 +28,16 @@ <h3 class='mb0 no-anchor'>ml-tree-similarity</h3>
<ul class='list-reset h5 py1-ul'>


<li><a
href='#compresstree'
class="">
compressTree

</a>

</li>


<li><a
href='#createtree'
class="">
Expand Down Expand Up @@ -77,6 +87,109 @@ <h3 class='mb0 no-anchor'>ml-tree-similarity</h3>
<div id='split-right' class='relative overflow-auto height-viewport-100'>


<section class='p2 mb2 clearfix bg-white minishadow'>


<div class='clearfix'>

<h3 class='fl m0' id='compresstree'>
compressTree
</h3>


<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/mljs/tree-similarity/blob/226db00203d5286ae5873b3c12cdfb19a2905c60/src/compressTree.js#L9-L25'>
<span>src/compressTree.js</span>
</a>

</div>


<p>Destructive compression in which we reduce the number of decimals</p>

<div class='pre p1 fill-light mt0'>compressTree(tree: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>, options: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</div>











<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>

<div class='space-bottom0'>
<div>
<span class='code bold'>tree</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</code>

</div>

</div>

<div class='space-bottom0'>
<div>
<span class='code bold'>options</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>
= <code>{}</code>)</code>

</div>

<table class='mt1 mb2 fixed-table h5 col-12'>
<colgroup>
<col width='30%' />
<col width='70%' />
</colgroup>
<thead>
<tr class='bold fill-light'>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody class='mt1'>

<tr>
<td class='break-word'><span class='code bold'>options.fixed</span> <code class='quiet'><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code>

(default <code>undefined</code>)
</td>
<td class='break-word'><span>number of decimal ot keep
</span></td>
</tr>



</tbody>
</table>

</div>

</div>



















</section>




<section class='p2 mb2 clearfix bg-white minishadow'>


Expand All @@ -87,7 +200,7 @@ <h3 class='fl m0' id='createtree'>
</h3>


<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/mljs/tree-similarity/blob/c43482e0c5dfaa1e6798e7d905fd999be12eb1cf/src/createTree.js#L16-L26'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/mljs/tree-similarity/blob/226db00203d5286ae5873b3c12cdfb19a2905c60/src/createTree.js#L15-L25'>
<span>src/createTree.js</span>
</a>

Expand Down Expand Up @@ -162,7 +275,7 @@ <h3 class='fl m0' id='createtree'>
</h3>


<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/mljs/tree-similarity/blob/c43482e0c5dfaa1e6798e7d905fd999be12eb1cf/src/createTree.js#L16-L26'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/mljs/tree-similarity/blob/226db00203d5286ae5873b3c12cdfb19a2905c60/src/createTree.js#L15-L25'>
<span>src/createTree.js</span>
</a>

Expand Down Expand Up @@ -245,7 +358,7 @@ <h3 class='fl m0' id='treesimilarity'>
</h3>


<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/mljs/tree-similarity/blob/c43482e0c5dfaa1e6798e7d905fd999be12eb1cf/src/treeSimilarity.js#L12-L38'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/mljs/tree-similarity/blob/226db00203d5286ae5873b3c12cdfb19a2905c60/src/treeSimilarity.js#L12-L38'>
<span>src/treeSimilarity.js</span>
</a>

Expand Down Expand Up @@ -328,7 +441,7 @@ <h3 class='fl m0' id='treesimilarity'>
</h3>


<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/mljs/tree-similarity/blob/c43482e0c5dfaa1e6798e7d905fd999be12eb1cf/src/treeSimilarity.js#L12-L38'>
<a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/mljs/tree-similarity/blob/226db00203d5286ae5873b3c12cdfb19a2905c60/src/treeSimilarity.js#L12-L38'>
<span>src/treeSimilarity.js</span>
</a>

Expand Down

0 comments on commit 8d5d60c

Please sign in to comment.