com.hfg.util.collection.SymmetricNumberMatrix Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.util.collection;



//------------------------------------------------------------------------------
/**
 Symmetric matrix specifically for Numbers.
 
  @author J. Alex Taylor, hairyfatguy.com
 
 */
//------------------------------------------------------------------------------
// com.hfg Library
//
// This library 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 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------
public class SymmetricNumberMatrix extends SymmetricMatrix
{

   //##########################################################################
   // CONSTRUCTORS
   //##########################################################################

   //--------------------------------------------------------------------------
   public SymmetricNumberMatrix()
   {
      super();
   }

   //--------------------------------------------------------------------------
   public SymmetricNumberMatrix(int inInitialCapacity)
   {
      super(inInitialCapacity);
   }

   //##########################################################################
   // PUBLIC METHODS
   //##########################################################################

   //--------------------------------------------------------------------------
   public SymmetricNumberMatrix clone()
   {
      return (SymmetricNumberMatrix) super.clone();
   }

   //--------------------------------------------------------------------------
   public Float getSumForKey(K inKey)
   {
      // To find all values for this key we need to go over and down
      int matrixRowIndex = getIndexForKey(inKey);

      MatrixRow matrixRow = mMatrix.get(matrixRowIndex);

      Float sum = 0.0f;
      for (V value : matrixRow.getData())
      {
         if (value != null)
         {
            sum += value.floatValue();
         }
      }

      // Now go down
      for (int i = matrixRowIndex + 1; i < mMatrix.size(); i++)
      {
         MatrixRow additionalRow = mMatrix.get(i);

         V value = additionalRow.getData().get(matrixRowIndex);
         if (value != null)
         {
            sum += value.floatValue();
         }
      }

      return sum;
   }
}