Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@kohlmayer
kohlmayer committed Sep 1, 2016
1 parent f924f9b commit 0f2d3e2
Show file tree
Hide file tree
Showing 63 changed files with 2,078 additions and 329 deletions.
1 change: 1 addition & 0 deletions doc/api/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ <h1 class="bar">All Classes</h1>
<li><a href="org/deidentifier/arx/metric/InformationLossDefaultWithBound.html" title="class in org.deidentifier.arx.metric" target="classFrame">InformationLossDefaultWithBound</a></li>
<li><a href="org/deidentifier/arx/metric/InformationLossWithBound.html" title="class in org.deidentifier.arx.metric" target="classFrame">InformationLossWithBound</a></li>
<li><a href="org/deidentifier/arx/metric/v2/IO.html" title="class in org.deidentifier.arx.metric.v2" target="classFrame">IO</a></li>
<li><a href="org/deidentifier/arx/io/IOUtil.html" title="class in org.deidentifier.arx.io" target="classFrame">IOUtil</a></li>
<li><a href="org/deidentifier/arx/criteria/KAnonymity.html" title="class in org.deidentifier.arx.criteria" target="classFrame">KAnonymity</a></li>
<li><a href="org/deidentifier/arx/criteria/KMap.html" title="class in org.deidentifier.arx.criteria" target="classFrame">KMap</a></li>
<li><a href="org/deidentifier/arx/criteria/KMap.CellSizeEstimator.html" title="enum in org.deidentifier.arx.criteria" target="classFrame">KMap.CellSizeEstimator</a></li>
Expand Down
1 change: 1 addition & 0 deletions doc/api/allclasses-noframe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ <h1 class="bar">All Classes</h1>
<li><a href="org/deidentifier/arx/metric/InformationLossDefaultWithBound.html" title="class in org.deidentifier.arx.metric">InformationLossDefaultWithBound</a></li>
<li><a href="org/deidentifier/arx/metric/InformationLossWithBound.html" title="class in org.deidentifier.arx.metric">InformationLossWithBound</a></li>
<li><a href="org/deidentifier/arx/metric/v2/IO.html" title="class in org.deidentifier.arx.metric.v2">IO</a></li>
<li><a href="org/deidentifier/arx/io/IOUtil.html" title="class in org.deidentifier.arx.io">IOUtil</a></li>
<li><a href="org/deidentifier/arx/criteria/KAnonymity.html" title="class in org.deidentifier.arx.criteria">KAnonymity</a></li>
<li><a href="org/deidentifier/arx/criteria/KMap.html" title="class in org.deidentifier.arx.criteria">KMap</a></li>
<li><a href="org/deidentifier/arx/criteria/KMap.CellSizeEstimator.html" title="enum in org.deidentifier.arx.criteria">KMap.CellSizeEstimator</a></li>
Expand Down
4 changes: 4 additions & 0 deletions doc/api/index-files/index-19.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,10 @@ <h2 class="title">T</h2>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="../org/deidentifier/arx/aggregates/classification/MultiClassZeroR.html#train(org.deidentifier.arx.DataHandleInternal,%20org.deidentifier.arx.DataHandleInternal,%20int)">train(DataHandleInternal, DataHandleInternal, int)</a></span> - Method in class org.deidentifier.arx.aggregates.classification.<a href="../org/deidentifier/arx/aggregates/classification/MultiClassZeroR.html" title="class in org.deidentifier.arx.aggregates.classification">MultiClassZeroR</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="../org/deidentifier/arx/io/IOUtil.html#trim(java.lang.String)">trim(String)</a></span> - Static method in class org.deidentifier.arx.io.<a href="../org/deidentifier/arx/io/IOUtil.html" title="class in org.deidentifier.arx.io">IOUtil</a></dt>
<dd>
<div class="block">Trims a given string.</div>
</dd>
<dt><a href="../org/deidentifier/arx/metric/v2/TupleMatcher.html" title="class in org.deidentifier.arx.metric.v2"><span class="strong">TupleMatcher</span></a> - Class in <a href="../org/deidentifier/arx/metric/v2/package-summary.html">org.deidentifier.arx.metric.v2</a></dt>
<dd>
<div class="block">A class that supports associating input with output</div>
Expand Down
6 changes: 6 additions & 0 deletions doc/api/index-files/index-9.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -506,6 +506,12 @@ <h2 class="title">I</h2>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="../org/deidentifier/arx/metric/v2/IO.html#IO()">IO()</a></span> - Constructor for class org.deidentifier.arx.metric.v2.<a href="../org/deidentifier/arx/metric/v2/IO.html" title="class in org.deidentifier.arx.metric.v2">IO</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../org/deidentifier/arx/io/IOUtil.html" title="class in org.deidentifier.arx.io"><span class="strong">IOUtil</span></a> - Class in <a href="../org/deidentifier/arx/io/package-summary.html">org.deidentifier.arx.io</a></dt>
<dd>
<div class="block">Utility for I/O</div>
</dd>
<dt><span class="strong"><a href="../org/deidentifier/arx/io/IOUtil.html#IOUtil()">IOUtil()</a></span> - Constructor for class org.deidentifier.arx.io.<a href="../org/deidentifier/arx/io/IOUtil.html" title="class in org.deidentifier.arx.io">IOUtil</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="../org/deidentifier/arx/criteria/KMap.html#isAccurate()">isAccurate()</a></span> - Method in class org.deidentifier.arx.criteria.<a href="../org/deidentifier/arx/criteria/KMap.html" title="class in org.deidentifier.arx.criteria">KMap</a></dt>
<dd>
<div class="block">Return true if the population has been modeled explicitly.</div>
Expand Down
62 changes: 31 additions & 31 deletions doc/api/org/deidentifier/arx/AttributeType.MicroAggregationFunction.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -332,48 +332,48 @@ <h4>createGeneralization</h4>
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="createInterval()">
<a name="createGeometricMean()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createInterval</h4>
<pre>public static&nbsp;<a href="../../../org/deidentifier/arx/AttributeType.MicroAggregationFunction.html" title="class in org.deidentifier.arx">AttributeType.MicroAggregationFunction</a>&nbsp;createInterval()</pre>
<div class="block">Creates a microaggregation function returning intervals. Ignores missing data.</div>
<h4>createGeometricMean</h4>
<pre>public static&nbsp;<a href="../../../org/deidentifier/arx/AttributeType.MicroAggregationFunction.html" title="class in org.deidentifier.arx">AttributeType.MicroAggregationFunction</a>&nbsp;createGeometricMean()</pre>
<div class="block">Creates a microaggregation function returning the geometric mean. Ignores missing data.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="createInterval(boolean)">
<a name="createGeometricMean(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createInterval</h4>
<pre>public static&nbsp;<a href="../../../org/deidentifier/arx/AttributeType.MicroAggregationFunction.html" title="class in org.deidentifier.arx">AttributeType.MicroAggregationFunction</a>&nbsp;createInterval(boolean&nbsp;ignoreMissingData)</pre>
<div class="block">Creates a microaggregation function returning intervals.</div>
<h4>createGeometricMean</h4>
<pre>public static&nbsp;<a href="../../../org/deidentifier/arx/AttributeType.MicroAggregationFunction.html" title="class in org.deidentifier.arx">AttributeType.MicroAggregationFunction</a>&nbsp;createGeometricMean(boolean&nbsp;ignoreMissingData)</pre>
<div class="block">Creates a microaggregation function returning the geometric mean.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ignoreMissingData</code> - Should the function ignore missing data. Default is true.</dd>
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="createGeometricMean()">
<a name="createInterval()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createGeometricMean</h4>
<pre>public static&nbsp;<a href="../../../org/deidentifier/arx/AttributeType.MicroAggregationFunction.html" title="class in org.deidentifier.arx">AttributeType.MicroAggregationFunction</a>&nbsp;createGeometricMean()</pre>
<div class="block">Creates a microaggregation function returning the geometric mean. Ignores missing data.</div>
<h4>createInterval</h4>
<pre>public static&nbsp;<a href="../../../org/deidentifier/arx/AttributeType.MicroAggregationFunction.html" title="class in org.deidentifier.arx">AttributeType.MicroAggregationFunction</a>&nbsp;createInterval()</pre>
<div class="block">Creates a microaggregation function returning intervals. Ignores missing data.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="createGeometricMean(boolean)">
<a name="createInterval(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createGeometricMean</h4>
<pre>public static&nbsp;<a href="../../../org/deidentifier/arx/AttributeType.MicroAggregationFunction.html" title="class in org.deidentifier.arx">AttributeType.MicroAggregationFunction</a>&nbsp;createGeometricMean(boolean&nbsp;ignoreMissingData)</pre>
<div class="block">Creates a microaggregation function returning the geometric mean.</div>
<h4>createInterval</h4>
<pre>public static&nbsp;<a href="../../../org/deidentifier/arx/AttributeType.MicroAggregationFunction.html" title="class in org.deidentifier.arx">AttributeType.MicroAggregationFunction</a>&nbsp;createInterval(boolean&nbsp;ignoreMissingData)</pre>
<div class="block">Creates a microaggregation function returning intervals.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ignoreMissingData</code> - Should the function ignore missing data. Default is true.</dd>
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
Expand Down Expand Up @@ -424,6 +424,20 @@ <h4>createMode</h4>
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="clone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<a href="../../../org/deidentifier/arx/AttributeType.MicroAggregationFunction.html" title="class in org.deidentifier.arx">AttributeType.MicroAggregationFunction</a>&nbsp;clone()</pre>
<div class="block">Clones this function</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../org/deidentifier/arx/AttributeType.html#clone()">clone</a></code>&nbsp;in class&nbsp;<code><a href="../../../org/deidentifier/arx/AttributeType.html" title="class in org.deidentifier.arx">AttributeType</a></code></dd>
</dl>
</li>
</ul>
<a name="getLabel()">
<!-- -->
</a>
Expand All @@ -449,28 +463,14 @@ <h4>getRequiredScale</h4>
<a name="isTypePreserving()">
<!-- -->
</a>
<ul class="blockList">
<ul class="blockListLast">
<li class="blockList">
<h4>isTypePreserving</h4>
<pre>public&nbsp;boolean&nbsp;isTypePreserving()</pre>
<div class="block">Returns whether this is a type-preserving function</div>
<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="clone()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<a href="../../../org/deidentifier/arx/AttributeType.MicroAggregationFunction.html" title="class in org.deidentifier.arx">AttributeType.MicroAggregationFunction</a>&nbsp;clone()</pre>
<div class="block">Clones this function</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../org/deidentifier/arx/AttributeType.html#clone()">clone</a></code>&nbsp;in class&nbsp;<code><a href="../../../org/deidentifier/arx/AttributeType.html" title="class in org.deidentifier.arx">AttributeType</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
26 changes: 13 additions & 13 deletions doc/api/org/deidentifier/arx/AttributeType.MicroAggregationFunctionDescription.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,18 @@ <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="createInstance(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createInstance</h4>
<pre>public abstract&nbsp;<a href="../../../org/deidentifier/arx/AttributeType.MicroAggregationFunction.html" title="class in org.deidentifier.arx">AttributeType.MicroAggregationFunction</a>&nbsp;createInstance(boolean&nbsp;ignoreMissingData)</pre>
<div class="block">Creates an instance</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ignoreMissingData</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="getLabel()">
<!-- -->
</a>
Expand All @@ -174,25 +186,13 @@ <h4>getLabel</h4>
<a name="getRequiredScale()">
<!-- -->
</a>
<ul class="blockList">
<ul class="blockListLast">
<li class="blockList">
<h4>getRequiredScale</h4>
<pre>public&nbsp;<a href="../../../org/deidentifier/arx/DataScale.html" title="enum in org.deidentifier.arx">DataScale</a>&nbsp;getRequiredScale()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the requiredScale</dd></dl>
</li>
</ul>
<a name="createInstance(boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createInstance</h4>
<pre>public abstract&nbsp;<a href="../../../org/deidentifier/arx/AttributeType.MicroAggregationFunction.html" title="class in org.deidentifier.arx">AttributeType.MicroAggregationFunction</a>&nbsp;createInstance(boolean&nbsp;ignoreMissingData)</pre>
<div class="block">Creates an instance</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ignoreMissingData</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
24 changes: 12 additions & 12 deletions doc/api/org/deidentifier/arx/AttributeType.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,17 @@ <h4>QUASI_IDENTIFYING_ATTRIBUTE</h4>
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="listMicroAggregationFunctions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listMicroAggregationFunctions</h4>
<pre>public static&nbsp;java.util.List&lt;<a href="../../../org/deidentifier/arx/AttributeType.MicroAggregationFunctionDescription.html" title="class in org.deidentifier.arx">AttributeType.MicroAggregationFunctionDescription</a>&gt;&nbsp;listMicroAggregationFunctions()</pre>
<div class="block">Lists all available microaggregation functions</div>
<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="clone()">
<!-- -->
</a>
Expand All @@ -299,7 +310,7 @@ <h4>clone</h4>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
Expand All @@ -310,17 +321,6 @@ <h4>toString</h4>
<dt><span class="strong">Returns:</span></dt><dd>the string</dd></dl>
</li>
</ul>
<a name="listMicroAggregationFunctions()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>listMicroAggregationFunctions</h4>
<pre>public static&nbsp;java.util.List&lt;<a href="../../../org/deidentifier/arx/AttributeType.MicroAggregationFunctionDescription.html" title="class in org.deidentifier.arx">AttributeType.MicroAggregationFunctionDescription</a>&gt;&nbsp;listMicroAggregationFunctions()</pre>
<div class="block">Lists all available microaggregation functions</div>
<dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
8 changes: 4 additions & 4 deletions doc/api/org/deidentifier/arx/class-use/DataScale.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,14 +103,14 @@ <h3>Uses of <a href="../../../../org/deidentifier/arx/DataScale.html" title="enu
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/deidentifier/arx/DataScale.html" title="enum in org.deidentifier.arx">DataScale</a></code></td>
<td class="colLast"><span class="strong">AttributeType.MicroAggregationFunctionDescription.</span><code><strong><a href="../../../../org/deidentifier/arx/AttributeType.MicroAggregationFunctionDescription.html#getRequiredScale()">getRequiredScale</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/deidentifier/arx/DataScale.html" title="enum in org.deidentifier.arx">DataScale</a></code></td>
<td class="colLast"><span class="strong">AttributeType.MicroAggregationFunction.</span><code><strong><a href="../../../../org/deidentifier/arx/AttributeType.MicroAggregationFunction.html#getRequiredScale()">getRequiredScale</a></strong>()</code>
<div class="block">Returns the required scale of measure</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/deidentifier/arx/DataScale.html" title="enum in org.deidentifier.arx">DataScale</a></code></td>
<td class="colLast"><span class="strong">AttributeType.MicroAggregationFunctionDescription.</span><code><strong><a href="../../../../org/deidentifier/arx/AttributeType.MicroAggregationFunctionDescription.html#getRequiredScale()">getRequiredScale</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/deidentifier/arx/DataScale.html" title="enum in org.deidentifier.arx">DataScale</a></code></td>
<td class="colLast"><span class="strong">DataType.DataTypeDescription.</span><code><strong><a href="../../../../org/deidentifier/arx/DataType.DataTypeDescription.html#getScale()">getScale</a></strong>()</code>&nbsp;</td>
Expand Down
Loading

0 comments on commit 0f2d3e2

Please sign in to comment.