https://github.com/statycc/pymwp
Tip revision: 8fdddf83f8362412a419889c3acb41bfa6b383d8 authored by <> on 08 March 2022, 03:11:17 UTC
Deployed 0f004aa with MkDocs version: 1.2.3
Deployed 0f004aa with MkDocs version: 1.2.3
Tip revision: 8fdddf8
index.html
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Implementation of MWP analysis on C code in Python.">
<link rel="icon" href=".">
<meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.2.5">
<title>pymwp</title>
<link rel="stylesheet" href="assets/stylesheets/main.2d9f7617.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.e6a45f82.min.css">
<meta name="theme-color" content="#546d78">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CSource+Code+Pro:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Inter";--md-code-font:"Source Code Pro"}</style>
<link rel="stylesheet" href="assets/_mkdocstrings.css">
<link rel="stylesheet" href="assets/styles.css">
<script>__md_scope=new URL(".",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="light" data-md-color-primary="blue-grey" data-md-color-accent="indigo">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#pymwp" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="." title="pymwp" class="md-header__button md-logo" aria-label="pymwp" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
pymwp
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Installation & Use
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/statycc/pymwp/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
statycc/pymwp
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="." title="pymwp" class="md-nav__button md-logo" aria-label="pymwp" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
</a>
pymwp
</label>
<div class="md-nav__source">
<a href="https://github.com/statycc/pymwp/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
statycc/pymwp
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Installation & Use
<span class="md-nav__icon md-icon"></span>
</label>
<a href="." class="md-nav__link md-nav__link--active">
Installation & Use
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#installation" class="md-nav__link">
Installation
</a>
</li>
<li class="md-nav__item">
<a href="#how-to-use" class="md-nav__link">
How to Use
</a>
</li>
<li class="md-nav__item">
<a href="#running-from-source" class="md-nav__link">
Running from source
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="features/" class="md-nav__link">
Supported Features
</a>
</li>
<li class="md-nav__item">
<a href="examples/" class="md-nav__link">
Examples
</a>
</li>
<li class="md-nav__item">
<a href="demo/" class="md-nav__link">
Demo
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
<label class="md-nav__link" for="__nav_5">
Modules
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Modules" data-md-level="1">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Modules
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="analysis/" class="md-nav__link">
Analysis
</a>
</li>
<li class="md-nav__item">
<a href="choice/" class="md-nav__link">
Choice
</a>
</li>
<li class="md-nav__item">
<a href="delta_graphs/" class="md-nav__link">
Delta Graphs
</a>
</li>
<li class="md-nav__item">
<a href="file_io/" class="md-nav__link">
File I/O
</a>
</li>
<li class="md-nav__item">
<a href="matrix/" class="md-nav__link">
Matrix
</a>
</li>
<li class="md-nav__item">
<a href="monomial/" class="md-nav__link">
Monomial
</a>
</li>
<li class="md-nav__item">
<a href="polynomial/" class="md-nav__link">
Polynomial
</a>
</li>
<li class="md-nav__item">
<a href="relation/" class="md-nav__link">
Relation
</a>
</li>
<li class="md-nav__item">
<a href="relation_list/" class="md-nav__link">
Relation List
</a>
</li>
<li class="md-nav__item">
<a href="semiring/" class="md-nav__link">
Semiring
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="utilities/" class="md-nav__link">
Utilities
</a>
</li>
<li class="md-nav__item">
<a href="https://github.com/statycc/pymwp" class="md-nav__link">
Source Code
</a>
</li>
<li class="md-nav__item">
<a href="https://github.com/statycc/pymwp/releases" class="md-nav__link">
Release History
</a>
</li>
<li class="md-nav__item">
<a href="https://github.com/statycc/pymwp/blob/master/LICENCE.md" class="md-nav__link">
License
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#installation" class="md-nav__link">
Installation
</a>
</li>
<li class="md-nav__item">
<a href="#how-to-use" class="md-nav__link">
How to Use
</a>
</li>
<li class="md-nav__item">
<a href="#running-from-source" class="md-nav__link">
Running from source
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/statycc/pymwp/blob/master/docs/index.md" title="Edit this page" class="md-content__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
</a>
<h1 id="pymwp">pymwp</h1>
<p><strong>Implementation of MWP analysis on C code in Python.</strong></p>
<!-- BEGIN INCLUDE ../README.md <!--desc-start--> <!--desc-end--> -->
<p>pymwp is a tool for automatically performing static analysis on programs written in C, inspired by <a href="https://doi.org/10.1145/1555746.1555752"><em>"A Flow Calculus of mwp-Bounds for Complexity Analysis"</em></a>.
It analyzes resource usage and determines if a program's variables growth rates are no more than polynomially related to their inputs sizes.
You can run our <a href="https://statycc.github.io/pymwp/examples/">many examples</a> on-line <a href="https://statycc.github.io/pymwp/demo/">in our demo</a> before <a href="https://statycc.github.io/pymwp/">installing it</a>, consult our list of <a href="https://statycc.github.io/pymwp/features/">supported C language features</a>,
or review latest <a href="https://github.com/statycc/pymwp/releases/tag/profile-latest">profiling results</a> for interesting metrics. </p>
<!-- END INCLUDE -->
<!-- BEGIN INCLUDE ../README.md <!--include-start--> <!--include-end--> -->
<h2 id="installation">Installation</h2>
<p>Install latest release from PyPI</p>
<div class="highlight"><pre><span></span><code>pip install pymwp
</code></pre></div>
<h2 id="how-to-use">How to Use</h2>
<p>To analyze a C file, run:</p>
<div class="highlight"><pre><span></span><code>pymwp path/to_some_file.c
</code></pre></div>
<p>For all available options and help, run:</p>
<div class="highlight"><pre><span></span><code>pymwp
</code></pre></div>
<p>You can also use pymwp in a Python script:</p>
<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">pymwp</span> <span class="kn">import</span> <span class="n">Polynomial</span>
<span class="kn">from</span> <span class="nn">pymwp.matrix</span> <span class="kn">import</span> <span class="n">identity_matrix</span><span class="p">,</span> <span class="n">show</span>
<span class="n">matrix</span> <span class="o">=</span> <span class="n">identity_matrix</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
<span class="n">matrix</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">Polynomial</span><span class="p">(</span><span class="s1">'m'</span><span class="p">)</span>
<span class="n">matrix</span><span class="p">[</span><span class="mi">1</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">Polynomial</span><span class="p">(</span><span class="s1">'w'</span><span class="p">)</span>
<span class="n">matrix</span><span class="p">[</span><span class="mi">2</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">Polynomial</span><span class="p">(</span><span class="s1">'p'</span><span class="p">)</span>
<span class="n">show</span><span class="p">(</span><span class="n">matrix</span><span class="p">)</span>
</code></pre></div>
<p>See <a href="https://statycc.github.io/pymwp/analysis/">modules documentation</a> for available methods.</p>
<h2 id="running-from-source">Running from source</h2>
<p>If you want to use the latest stable version (possibly ahead of
latest release), use the version from source following these steps.</p>
<ol>
<li>
<p>Clone the repository</p>
<div class="highlight"><pre><span></span><code>git clone https://github.com/statycc/pymwp.git
</code></pre></div>
</li>
<li>
<p>Set up Python environment</p>
<p>install required packages</p>
<div class="highlight"><pre><span></span><code>python -m pip install -q -r requirements.txt
</code></pre></div>
<p>Note: for development purposes or to run tests, install dev dependencies instead: </p>
<div class="highlight"><pre><span></span><code>python -m pip install -q -r requirements-dev.txt
</code></pre></div>
</li>
<li>
<p>Run the analysis</p>
<p>From project root run:
<div class="highlight"><pre><span></span><code>python -m pymwp path/to_some_file.c
</code></pre></div></p>
<p>for example:
<div class="highlight"><pre><span></span><code>python -m pymwp c_files/basics/if.c
</code></pre></div></p>
<p>for all available options and help, run:</p>
<div class="highlight"><pre><span></span><code>python -m pymwp
</code></pre></div>
</li>
</ol>
<!-- END INCLUDE -->
</article>
</div>
</div>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer">
<a href="features/" class="md-footer__link md-footer__link--next" aria-label="Next: Supported Features" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Supported Features
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": ".", "features": ["navigation.expand"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "assets/javascripts/workers/search.bd0b6b67.min.js"}</script>
<script src="assets/javascripts/bundle.467223ff.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.2/highlight.min.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="assets/config.js"></script>
</body>
</html>