aistudio-wpf-diagram/zxing.core/xx/common/BitMatrix.cs

/*
* Copyright 2007 ZXing authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

using System;
using System.Text;

namespace ZXing.Common
{
   /// <summary>
   ///   <p>Represents a 2D matrix of bits. In function arguments below, and throughout the common
   /// module, x is the column position, and y is the row position. The ordering is always x, y.
   /// The origin is at the top-left.</p>
   ///   <p>Internally the bits are represented in a 1-D array of 32-bit ints. However, each row begins
   /// with a new int. This is done intentionally so that we can copy out a row into a BitArray very
   /// efficiently.</p>
   ///   <p>The ordering of bits is row-major. Within each int, the least significant bits are used first,
   /// meaning they represent lower x values. This is compatible with BitArray's implementation.</p>
   /// </summary>
   /// <author>Sean Owen</author>
   /// <author>dswitkin@google.com (Daniel Switkin)</author>
   public sealed partial class BitMatrix
   {
      private readonly int width;
      private readonly int height;
      private readonly int rowSize;
      private readonly int[] bits;

      /// <returns> The width of the matrix
      /// </returns>
      public int Width
      {
         get { return width; }
      }

      /// <returns> The height of the matrix
      /// </returns>
      public int Height
      {
         get { return height; }
      }

      /// <summary> This method is for compatibility with older code. It's only logical to call if the matrix
      /// is square, so I'm throwing if that's not the case.
      /// 
      /// </summary>
      /// <returns> row/column dimension of this matrix
      /// </returns>
      public int Dimension
      {
         get
         {
            if (width != height)
            {
               throw new ArgumentException("Can't call Dimension on a non-square matrix");
            }
            return width;
         }

      }

      /// <returns>
      /// The rowsize of the matrix
      /// </returns>
      public int RowSize
      {
         get { return rowSize; }
      }

      // A helper to construct a square matrix.
      public BitMatrix(int dimension)
         : this(dimension, dimension)
      {
      }

      public BitMatrix(int width, int height)
      {
         if (width < 1 || height < 1)
         {
            throw new System.ArgumentException("Both dimensions must be greater than 0");
         }
         this.width = width;
         this.height = height;
         this.rowSize = (width + 31) >> 5;
         bits = new int[rowSize*height];
      }

      internal BitMatrix(int width, int height, int rowSize, int[] bits)
      {
         this.width = width;
         this.height = height;
         this.rowSize = rowSize;
         this.bits = bits;
      }

      internal BitMatrix(int width, int height, int[] bits)
      {
         this.width = width;
         this.height = height;
         this.rowSize = (width + 31) >> 5;
         this.bits = bits;
      }

      public static BitMatrix parse(String stringRepresentation, String setString, String unsetString)
      {
         if (stringRepresentation == null)
         {
            throw new ArgumentException();
         }

         bool[] bits = new bool[stringRepresentation.Length];
         int bitsPos = 0;
         int rowStartPos = 0;
         int rowLength = -1;
         int nRows = 0;
         int pos = 0;
         while (pos < stringRepresentation.Length)
         {
            if (stringRepresentation.Substring(pos, 1).Equals("\n") || 
                stringRepresentation.Substring(pos, 1).Equals("\r"))
            {
               if (bitsPos > rowStartPos)
               {
                  if (rowLength == -1)
                  {
                     rowLength = bitsPos - rowStartPos;
                  }
                  else if (bitsPos - rowStartPos != rowLength)
                  {
                     throw new ArgumentException("row lengths do not match");
                  }
                  rowStartPos = bitsPos;
                  nRows++;
               }
               pos++;
            }
            else if (stringRepresentation.Substring(pos, setString.Length).Equals(setString))
            {
               pos += setString.Length;
               bits[bitsPos] = true;
               bitsPos++;
            }
            else if (stringRepresentation.Substring(pos, unsetString.Length).Equals(unsetString))
            {
               pos += unsetString.Length;
               bits[bitsPos] = false;
               bitsPos++;
            }
            else
            {
               throw new ArgumentException("illegal character encountered: " + stringRepresentation.Substring(pos));
            }
         }

         // no EOL at end?
         if (bitsPos > rowStartPos)
         {
            if (rowLength == -1)
            {
               rowLength = bitsPos - rowStartPos;
            }
            else if (bitsPos - rowStartPos != rowLength)
            {
               throw new ArgumentException("row lengths do not match");
            }
            nRows++;
         }

         BitMatrix matrix = new BitMatrix(rowLength, nRows);
         for (int i = 0; i < bitsPos; i++)
         {
            if (bits[i])
            {
               matrix[i%rowLength, i/rowLength] = true;
            }
         }
         return matrix;
      }

      /// <summary> <p>Gets the requested bit, where true means black.</p>
      /// 
      /// </summary>
      /// <param name="x">The horizontal component (i.e. which column)
      /// </param>
      /// <param name="y">The vertical component (i.e. which row)
      /// </param>
      /// <returns> value of given bit in matrix
      /// </returns>
      public bool this[int x, int y]
      {
         get
         {
            int offset = y*rowSize + (x >> 5);
            return (((int) ((uint) (bits[offset]) >> (x & 0x1f))) & 1) != 0;
         }
         set
         {
            if (value)
            {
               int offset = y*rowSize + (x >> 5);
               bits[offset] |= 1 << (x & 0x1f);
            }
            else
            {
               int offset = y*rowSize + (x/32);
               bits[offset] &= ~(1 << (x & 0x1f));
            }
         }
      }

      /// <summary> <p>Flips the given bit.</p>
      /// 
      /// </summary>
      /// <param name="x">The horizontal component (i.e. which column)
      /// </param>
      /// <param name="y">The vertical component (i.e. which row)
      /// </param>
      public void flip(int x, int y)
      {
         int offset = y*rowSize + (x >> 5);
         bits[offset] ^= 1 << (x & 0x1f);
      }

      /// <summary>
      /// Exclusive-or (XOR): Flip the bit in this {@code BitMatrix} if the corresponding
      /// mask bit is set.
      /// </summary>
      /// <param name="mask">The mask.</param>
      public void xor(BitMatrix mask)
      {
         if (width != mask.Width || height != mask.Height
             || rowSize != mask.RowSize)
         {
            throw new ArgumentException("input matrix dimensions do not match");
         }
         var rowArray = new BitArray(width/32 + 1);
         for (int y = 0; y < height; y++)
         {
            int offset = y*rowSize;
            int[] row = mask.getRow(y, rowArray).Array;
            for (int x = 0; x < rowSize; x++)
            {
               bits[offset + x] ^= row[x];
            }
         }
      }

      /// <summary> Clears all bits (sets to false).</summary>
      public void clear()
      {
         int max = bits.Length;
         for (int i = 0; i < max; i++)
         {
            bits[i] = 0;
         }
      }

      /// <summary> <p>Sets a square region of the bit matrix to true.</p>
      /// 
      /// </summary>
      /// <param name="left">The horizontal position to begin at (inclusive)
      /// </param>
      /// <param name="top">The vertical position to begin at (inclusive)
      /// </param>
      /// <param name="width">The width of the region
      /// </param>
      /// <param name="height">The height of the region
      /// </param>
      public void setRegion(int left, int top, int width, int height)
      {
         if (top < 0 || left < 0)
         {
            throw new System.ArgumentException("Left and top must be nonnegative");
         }
         if (height < 1 || width < 1)
         {
            throw new System.ArgumentException("Height and width must be at least 1");
         }
         int right = left + width;
         int bottom = top + height;
         if (bottom > this.height || right > this.width)
         {
            throw new System.ArgumentException("The region must fit inside the matrix");
         }
         for (int y = top; y < bottom; y++)
         {
            int offset = y*rowSize;
            for (int x = left; x < right; x++)
            {
               bits[offset + (x >> 5)] |= 1 << (x & 0x1f);
            }
         }
      }

      /// <summary> A fast method to retrieve one row of data from the matrix as a BitArray.
      /// 
      /// </summary>
      /// <param name="y">The row to retrieve
      /// </param>
      /// <param name="row">An optional caller-allocated BitArray, will be allocated if null or too small
      /// </param>
      /// <returns> The resulting BitArray - this reference should always be used even when passing
      /// your own row
      /// </returns>
      public BitArray getRow(int y, BitArray row)
      {
         if (row == null || row.Size < width)
         {
            row = new BitArray(width);
         }
         else
         {
            row.clear();
         }
         int offset = y*rowSize;
         for (int x = 0; x < rowSize; x++)
         {
            row.setBulk(x << 5, bits[offset + x]);
         }
         return row;
      }

      /// <summary>
      /// Sets the row.
      /// </summary>
      /// <param name="y">row to set</param>
      /// <param name="row">{@link BitArray} to copy from</param>
      public void setRow(int y, BitArray row)
      {
         Array.Copy(row.Array, 0, bits, y*rowSize, rowSize);
      }

      /// <summary>
      /// Modifies this {@code BitMatrix} to represent the same but rotated 180 degrees
      /// </summary>
      public void rotate180()
      {
         var width = Width;
         var height = Height;
         var topRow = new BitArray(width);
         var bottomRow = new BitArray(width);
         for (int i = 0; i < (height + 1)/2; i++)
         {
            topRow = getRow(i, topRow);
            bottomRow = getRow(height - 1 - i, bottomRow);
            topRow.reverse();
            bottomRow.reverse();
            setRow(i, bottomRow);
            setRow(height - 1 - i, topRow);
         }
      }

      /// <summary>
      /// This is useful in detecting the enclosing rectangle of a 'pure' barcode.
      /// </summary>
      /// <returns>{left,top,width,height} enclosing rectangle of all 1 bits, or null if it is all white</returns>
      public int[] getEnclosingRectangle()
      {
         int left = width;
         int top = height;
         int right = -1;
         int bottom = -1;

         for (int y = 0; y < height; y++)
         {
            for (int x32 = 0; x32 < rowSize; x32++)
            {
               int theBits = bits[y*rowSize + x32];
               if (theBits != 0)
               {
                  if (y < top)
                  {
                     top = y;
                  }
                  if (y > bottom)
                  {
                     bottom = y;
                  }
                  if (x32*32 < left)
                  {
                     int bit = 0;
                     while ((theBits << (31 - bit)) == 0)
                     {
                        bit++;
                     }
                     if ((x32*32 + bit) < left)
                     {
                        left = x32*32 + bit;
                     }
                  }
                  if (x32*32 + 31 > right)
                  {
                     int bit = 31;
                     while (((int) ((uint) theBits >> bit)) == 0) // (theBits >>> bit)
                     {
                        bit--;
                     }
                     if ((x32*32 + bit) > right)
                     {
                        right = x32*32 + bit;
                     }
                  }
               }
            }
         }

         int widthTmp = right - left;
         int heightTmp = bottom - top;

         if (widthTmp < 0 || heightTmp < 0)
         {
            return null;
         }

         return new[] {left, top, widthTmp, heightTmp};
      }

      /// <summary>
      /// This is useful in detecting a corner of a 'pure' barcode.
      /// </summary>
      /// <returns>{x,y} coordinate of top-left-most 1 bit, or null if it is all white</returns>
      public int[] getTopLeftOnBit()
      {
         int bitsOffset = 0;
         while (bitsOffset < bits.Length && bits[bitsOffset] == 0)
         {
            bitsOffset++;
         }
         if (bitsOffset == bits.Length)
         {
            return null;
         }
         int y = bitsOffset/rowSize;
         int x = (bitsOffset%rowSize) << 5;

         int theBits = bits[bitsOffset];
         int bit = 0;
         while ((theBits << (31 - bit)) == 0)
         {
            bit++;
         }
         x += bit;
         return new[] {x, y};
      }

      public int[] getBottomRightOnBit()
      {
         int bitsOffset = bits.Length - 1;
         while (bitsOffset >= 0 && bits[bitsOffset] == 0)
         {
            bitsOffset--;
         }
         if (bitsOffset < 0)
         {
            return null;
         }

         int y = bitsOffset/rowSize;
         int x = (bitsOffset%rowSize) << 5;

         int theBits = bits[bitsOffset];
         int bit = 31;

         while (((int) ((uint) theBits >> bit)) == 0) // (theBits >>> bit)
         {
            bit--;
         }
         x += bit;

         return new int[] {x, y};
      }

      /// <summary>
      /// Determines whether the specified <see cref="System.Object"/> is equal to this instance.
      /// </summary>
      /// <param name="obj">The <see cref="System.Object"/> to compare with this instance.</param>
      /// <returns>
      ///   <c>true</c> if the specified <see cref="System.Object"/> is equal to this instance; otherwise, <c>false</c>.
      /// </returns>
      public override bool Equals(object obj)
      {
         if (!(obj is BitMatrix))
         {
            return false;
         }
         var other = (BitMatrix) obj;
         if (width != other.width || height != other.height ||
             rowSize != other.rowSize || bits.Length != other.bits.Length)
         {
            return false;
         }
         for (int i = 0; i < bits.Length; i++)
         {
            if (bits[i] != other.bits[i])
            {
               return false;
            }
         }
         return true;
      }

      /// <summary>
      /// Returns a hash code for this instance.
      /// </summary>
      /// <returns>
      /// A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. 
      /// </returns>
      public override int GetHashCode()
      {
         int hash = width;
         hash = 31*hash + width;
         hash = 31*hash + height;
         hash = 31*hash + rowSize;
         foreach (var bit in bits)
         {
            hash = 31*hash + bit.GetHashCode();
         }
         return hash;
      }

      /// <summary>
      /// Returns a <see cref="System.String"/> that represents this instance.
      /// </summary>
      /// <returns>
      /// A <see cref="System.String"/> that represents this instance.
      /// </returns>
      public override String ToString()
      {
         return ToString("X ", "  ", Environment.NewLine);
      }

      /// <summary>
      /// Returns a <see cref="System.String"/> that represents this instance.
      /// </summary>
      /// <param name="setString">The set string.</param>
      /// <param name="unsetString">The unset string.</param>
      /// <returns>
      /// A <see cref="System.String"/> that represents this instance.
      /// </returns>
      public String ToString(String setString, String unsetString)
      {
         return ToString(setString, unsetString, Environment.NewLine);
      }

      /// <summary>
      /// Returns a <see cref="System.String"/> that represents this instance.
      /// </summary>
      /// <param name="setString">The set string.</param>
      /// <param name="unsetString">The unset string.</param>
      /// <param name="lineSeparator">The line separator.</param>
      /// <returns>
      /// A <see cref="System.String"/> that represents this instance.
      /// </returns>
      public String ToString(String setString, String unsetString, String lineSeparator)
      {
         var result = new StringBuilder(height*(width + 1));
         for (int y = 0; y < height; y++)
         {
            for (int x = 0; x < width; x++)
            {
               result.Append(this[x, y] ? setString : unsetString);
            }
            result.Append(lineSeparator);
         }
         return result.ToString();
      }

      /// <summary>
      /// Clones this instance.
      /// </summary>
      /// <returns></returns>
      public object Clone()
      {
         return new BitMatrix(width, height, rowSize, (int[]) bits.Clone());
      }
   }
}