Skip to content

Commit

Permalink
Doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
andreas-zeller committed Jan 7, 2025
1 parent 7fad54e commit c493250
Show file tree
Hide file tree
Showing 17 changed files with 2,463 additions and 2,426 deletions.
20 changes: 15 additions & 5 deletions docs/beta/code/Alhazen.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Learning from Failures" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/Alhazen.html
# Last change: 2025-01-07 11:04:38+01:00
# Last change: 2025-01-07 11:35:49+01:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down Expand Up @@ -66,7 +66,10 @@
If the predicate evaluates to `True`, follow the left path; if it evaluates to `False`, follow the right path.
A leaf node (no children) will give you the final decision `class = BUG` or `class = NO_BUG`.
So if the predicate states ` == 'sqrt' <= 0.5`, this means that if the function is _not_ `sqrt`, follow the left (`True`) path. If it is `sqrt`, follow the right (`False`) path.
So if the predicate states ` == 'sqrt' <= 0.5`, this means that
* If the function is _not_ `sqrt` (the predicate ` == 'sqrt'` is negative, see above, and hence less than 0.5), follow the left (`True`) path.
* If the function _is_ `sqrt` (the predicate ` == 'sqrt'` is positive), follow the right (`False`) path.
The `samples` field shows the number of sample inputs that contributed to this decision.
The `gini` field (aka Gini impurity) indicates how many samples fall into the displayed class (`BUG` or `NO_BUG`).
Expand All @@ -77,9 +80,9 @@
>>> print(alhazen.friendly_decision_tree())
if <= 4.5000:
if <= 42.1500:
if == 'sqrt':
if <= -11.9137:
if == 'sqrt':
if <= 42.2000:
if <= -11.8470:
BUG
else:
NO_BUG
Expand Down Expand Up @@ -336,6 +339,13 @@ def execute_samples(sample_list):



### Internal and "Friendly" Feature Names

if __name__ == '__main__':
print('\n### Internal and "Friendly" Feature Names')



### Implementing Feature Classes

if __name__ == '__main__':
Expand Down
2 changes: 1 addition & 1 deletion docs/beta/code/Tours.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# "Tours through the Book" - a chapter of "The Debugging Book"
# Web site: https://www.debuggingbook.org/html/Tours.html
# Last change: 2025-01-07 11:01:55+01:00
# Last change: 2025-01-07 11:33:11+01:00
#
# Copyright (c) 2021-2023 CISPA Helmholtz Center for Information Security
# Copyright (c) 2018-2020 Saarland University, authors, and contributors
Expand Down
Binary file modified docs/beta/dist/debuggingbook-1.2.4.tar.gz
Binary file not shown.
Binary file modified docs/beta/dist/debuggingbook-code.zip
Binary file not shown.
Binary file modified docs/beta/dist/debuggingbook-notebooks.zip
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/beta/html/00_Index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12120,7 +12120,7 @@
<div class="text_cell_render border-box-sizing rendered_html"><h3 id="C">C<a class="anchor-link" href="#C">&#182;</a></h3><ul>
<li>C-Reduce &mdash; <a href="DeltaDebugger.html#Background">Reducing Failure-Inducing Inputs (Background)</a></li>
<li><code>CachingCallReducer</code> class &mdash; <a href="DeltaDebugger.html#Testing,-Logging,-and-Caching">Reducing Failure-Inducing Inputs (Testing, Logging, and Caching)</a></li>
<li><code>CALC_GRAMMAR</code> &mdash; <a href="Alhazen.html#Inputs-and-Grammars">Learning from Failures (Inputs and Grammars)</a>, <a href="Alhazen.html#Decision-Trees">Learning from Failures (Decision Trees)</a></li>
<li><code>CALC_GRAMMAR</code> &mdash; <a href="Alhazen.html#Inputs-and-Grammars">Learning from Failures (Inputs and Grammars)</a>, <a href="Alhazen.html#Internal-and-&quot;Friendly&quot;-Feature-Names">Learning from Failures (Internal and "Friendly" Feature Names)</a>, <a href="Alhazen.html#Decision-Trees">Learning from Failures (Decision Trees)</a></li>
<li>call stack &mdash; <a href="StackInspector.html#Inspecting-Call-Stacks">Inspecting Call Stacks (Inspecting Call Stacks)</a></li>
<li><code>call()</code> &mdash; <a href="Slicer.html#Excursion:-Tracking-Calls-and-Arguments">Tracking Failure Origins (Excursion: Tracking Calls and Arguments)</a>, <a href="Slicer.html#Excursion:-Calls-and-Returns">Tracking Failure Origins (Excursion: Calls and Returns)</a>, <a href="DeltaDebugger.html#Collecting-a-Call">Reducing Failure-Inducing Inputs (Collecting a Call)</a>, <a href="DeltaDebugger.html#Repeating-a-Call">Reducing Failure-Inducing Inputs (Repeating a Call)</a></li>
<li><code>CallCollector</code> class &mdash; <a href="Slicer.html#Excursion:-Implementing-Dynamic-Instrumentation">Tracking Failure Origins (Excursion: Implementing Dynamic Instrumentation)</a>, <a href="DeltaDebugger.html#Collecting-a-Call">Reducing Failure-Inducing Inputs (Collecting a Call)</a>, <a href="DeltaDebugger.html#Collecting-a-Call">Reducing Failure-Inducing Inputs (Collecting a Call)</a>, <a href="DeltaDebugger.html#Repeating-a-Call">Reducing Failure-Inducing Inputs (Repeating a Call)</a>, <a href="DeltaDebugger.html#Repeating-a-Call">Reducing Failure-Inducing Inputs (Repeating a Call)</a></li>
Expand Down
8 changes: 4 additions & 4 deletions docs/beta/html/00_Table_of_Contents.html
Original file line number Diff line number Diff line change
Expand Up @@ -12311,7 +12311,7 @@ <h4 id="Inspecting-Call-Stacks"><a href="StackInspector.html">Inspecting Call St
The content of this project is licensed under the
<a href="https://creativecommons.org/licenses/by-nc-sa/4.0/" target=_blank>Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
The source code that is part of the content, as well as the source code used to format and display that content is licensed under the <a href="https://github.com/uds-se/debuggingbook/blob/master/LICENSE.md#mit-license">MIT License</a>.
<a href="https://github.com/uds-se/debuggingbook/commits/master/notebooks/00_Table_of_Contents.ipynb" target=_blank)>Last change: 2025-01-07 11:05:13+01:00</a> &bull;
<a href="https://github.com/uds-se/debuggingbook/commits/master/notebooks/00_Table_of_Contents.ipynb" target=_blank)>Last change: 2025-01-07 11:36:02+01:00</a> &bull;
<a href="#citation" id="cite" onclick="revealCitation()">Cite</a> &bull;
<a href="https://cispa.de/en/impressum" target=_blank>Imprint</a>
</p>
Expand All @@ -12327,7 +12327,7 @@ <h4 id="Inspecting-Call-Stacks"><a href="StackInspector.html">Inspecting Call St
<a name="citation"></a>
<h2>How to Cite this Work</h2>
<p>
Andreas Zeller: "<a href="https://www.debuggingbook.org/beta/html/00_Table_of_Contents.html">The Debugging Book</a>". In Andreas Zeller, "<a href="https://www.debuggingbook.org/beta/">The Debugging Book</a>", <a href="https://www.debuggingbook.org/beta/html/00_Table_of_Contents.html">https://www.debuggingbook.org/beta/html/00_Table_of_Contents.html</a>. Retrieved 2025-01-07 11:05:13+01:00.
Andreas Zeller: "<a href="https://www.debuggingbook.org/beta/html/00_Table_of_Contents.html">The Debugging Book</a>". In Andreas Zeller, "<a href="https://www.debuggingbook.org/beta/">The Debugging Book</a>", <a href="https://www.debuggingbook.org/beta/html/00_Table_of_Contents.html">https://www.debuggingbook.org/beta/html/00_Table_of_Contents.html</a>. Retrieved 2025-01-07 11:36:02+01:00.
</p>
<pre>
@incollection{debuggingbook2025:00_Table_of_Contents,
Expand All @@ -12337,9 +12337,9 @@ <h2>How to Cite this Work</h2>
year = {2025},
publisher = {CISPA Helmholtz Center for Information Security},
howpublished = {\url{https://www.debuggingbook.org/beta/html/00_Table_of_Contents.html}},
note = {Retrieved 2025-01-07 11:05:13+01:00},
note = {Retrieved 2025-01-07 11:36:02+01:00},
url = {https://www.debuggingbook.org/beta/html/00_Table_of_Contents.html},
urldate = {2025-01-07 11:05:13+01:00}
urldate = {2025-01-07 11:36:02+01:00}
}
</pre>
</div>
Expand Down
Loading

0 comments on commit c493250

Please sign in to comment.