switch.html



<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Design Doc: Switch &mdash; PaddlePaddle  documentation</title>
  

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  

        <link rel="index" title="Index"
              href="../genindex.html"/>
        <link rel="search" title="Search" href="../search.html"/>
    <link rel="top" title="PaddlePaddle  documentation" href="../index.html"/> 

  
  <script src="../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

            <a href="../index_en.html" class="icon icon-home"> PaddlePaddle
          

          </a>

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
                <ul>
<li class="toctree-l1"><a class="reference internal" href="../getstarted/index_en.html">GET STARTED</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_and_install/index_en.html">Install and Build</a></li>
<li class="toctree-l1"><a class="reference internal" href="../howto/index_en.html">HOW TO</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev/index_en.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq/index_en.html">FAQ</a></li>
</ul>

            
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="../index_en.html">PaddlePaddle</a>
      </nav>


      <div class="wy-nav-content">
        <div class="rst-content">
          

<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="../index_en.html">Docs</a> &raquo;</li>
      
    <li>Design Doc: Switch</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../_sources/design/switch.md.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="design-doc-switch">
<span id="design-doc-switch"></span><h1>Design Doc: Switch<a class="headerlink" href="#design-doc-switch" title="Permalink to this headline">¶</a></h1>
</div>
<div class="section" id="background">
<span id="background"></span><h1>Background<a class="headerlink" href="#background" title="Permalink to this headline">¶</a></h1>
<p>Many programming languages provide <code class="docutils literal"><span class="pre">switch</span></code> as a generalization of <code class="docutils literal"><span class="pre">if-elif-else</span></code>.  We want to add it to Fluid.</p>
<p>The following example shows the usage of <code class="docutils literal"><span class="pre">fluid.switch</span></code>.</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">a</span> <span class="o">=</span> <span class="n">fluid</span><span class="o">.</span><span class="n">Var</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">fluid</span><span class="o">.</span><span class="n">Var</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>

<span class="k">with</span> <span class="n">switch</span><span class="p">()</span> <span class="k">as</span> <span class="n">switch</span><span class="p">:</span>
    <span class="k">with</span> <span class="n">switch</span><span class="o">.</span><span class="n">case</span><span class="p">(</span><span class="n">fluid</span><span class="o">.</span><span class="n">less_equal</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="mi">10</span><span class="p">)):</span>
        <span class="n">fluid</span><span class="o">.</span><span class="k">print</span><span class="p">(</span><span class="s2">&quot;Case 1&quot;</span><span class="p">)</span>
    <span class="k">with</span> <span class="n">switch</span><span class="o">.</span><span class="n">case</span><span class="p">(</span><span class="n">fluid</span><span class="o">.</span><span class="n">larger</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="mi">0</span><span class="p">)):</span>
        <span class="n">fluid</span><span class="o">.</span><span class="k">print</span><span class="p">(</span><span class="s2">&quot;Case 2&quot;</span><span class="p">)</span>
    <span class="k">with</span> <span class="n">switch</span><span class="o">.</span><span class="n">default</span><span class="p">():</span>
        <span class="n">fluid</span><span class="o">.</span><span class="k">print</span><span class="p">(</span><span class="s2">&quot;Case 3&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="the-semantics">
<span id="the-semantics"></span><h1>The Semantics<a class="headerlink" href="#the-semantics" title="Permalink to this headline">¶</a></h1>
<ol class="simple">
<li>A <code class="docutils literal"><span class="pre">switch</span></code> control-flow checks cases one-by-one.</li>
<li>The condition of each case is a boolean value, which is a scalar, and differs from the <code class="docutils literal"><span class="pre">fluid.if_else</span></code> control-flow, which condition could be a vector of boolean values.</li>
<li>It runs the first matched case, or the default case if there is one.</li>
<li>Once it matches a case, it runs the corresponding branch and only that branch.  It&#8217;s like there is a C&#8217;s <code class="docutils literal"><span class="pre">break</span></code> keyword at the end of each case.</li>
</ol>
<p>The above program should print and print only &#8220;Case 1&#8221;.</p>
<p>The implementation of the backward pass of the <code class="docutils literal"><span class="pre">switch</span></code> control-flow is easier than the backward of the <code class="docutils literal"><span class="pre">if_else</span></code>, because <code class="docutils literal"><span class="pre">switch</span></code> runs at most one branch, whereas <code class="docutils literal"><span class="pre">if-else</span></code> could run more than one branches.</p>
</div>


           </div>
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2016, PaddlePaddle developers.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../',
            VERSION:'',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="../_static/jquery.js"></script>
      <script type="text/javascript" src="../_static/underscore.js"></script>
      <script type="text/javascript" src="../_static/doctools.js"></script>
      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

  
    <script type="text/javascript" src="../_static/js/theme.js"></script>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>