tame/core/vector/arithmetic.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
  Copyright (C) 2015  LoVullo Associates, Inc.

  This file is part of tame-core.

  tame-core is free software: you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation, either version 3 of the
  License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
-->
<package xmlns="http://www.lovullo.com/rater"
  xmlns:c="http://www.lovullo.com/calc"
  xmlns:t="http://www.lovullo.com/rater/apply-template"
  core="true"
  desc="Vector arithmetic">

  <import package="../base" />
  <import package="../numeric/common" />
  <import package="../numeric/minmax" />



  <!-- for the time being, the vectors must be of the same length, or the first
       vector must be the longer (otherwise the values will not properly add)
       -->
  <template name="_vadd_" desc="Produce a vector resulting from the addition of two vectors">
    <param name="@a@" desc="First vector to add" />
    <param name="@b@" desc="Second vector to add" />
    <param name="@into@" desc="Variable to yield vector into" />

    <param name="@yields@" desc="Value to yield (useless)">
      <text>__</text>
      <param-value name="@into@" />
    </param>

    <param name="@gendesc@" desc="Generator description (for @into@)">
      <text>Sum of vectors </text>
      <param-value name="@a@" />
      <text> and </text>
      <param-value name="@b@" />
    </param>

    <param name="@sym@" desc="Generator symbol">
      <!-- empty by default -->
      <text></text>
    </param>

    <rate accumulate="none" yields="@yields@">
      <c:sum of="@a@" index="k" generates="@into@" desc="@gendesc@" sym="@sym@">
        <c:value-of name="@a@" index="k" />
        <c:value-of name="@b@" index="k" />
      </c:sum>
    </rate>
  </template>


  <template name="_vsum_" desc="Yield sum of all elements of a vector as a scalar">
    <param name="@of@"     desc="Vector to sum" />
    <param name="@yields@" desc="Name of scalar to yield" />

    <rate yields="@yields@">
      <c:sum of="@of@" />
    </rate>
  </template>
</package>