ExpIterator.cs

Go to the documentation of this file.

#region #Usings

using System;
using System.Linq;

#endregion

namespace Britbot
{
    internal class ExpIterator
    {
        #region Fields & Properies

        public int[] Dimensions { get; private set; }

        public int[] Values { get; set; }

        #endregion

        #region Constructors & Initializers

        public ExpIterator(int[] dims)
        {
            //set the given dimensions

            this.Dimensions = dims;

            //check if dimensions are legal (meaning strictly positive)
            if (Dimensions.Any(dim => dim <= 0))
            {
                throw new InvalidIteratorDimensionException("Dimensions must be strictly positive");
            }

            //initiate count at zero
            this.Values = new int[dims.Length];
            for (int i = 0; i < this.Values.Length; i++)
            {
                Values[i] = 0;
            }
        }

        #endregion

        public bool IsZero()
        {
            //going over the list searching for nonzero
            foreach (int value in this.Values)
            {
                if (value != 0)
                    return false;
            }

            //if here it means that all the entries are zero
            return true;
        }

        public bool NextIteration()
        {
            //going over the vector entries
            for (int i = 0; i < this.Values.Length; i++)
            {
                //if we don't need to go over the top of the dimension just add

                if (this.Values[i] < this.Dimensions[i] - 1)
                {
                    this.Values[i]++;
                    break;
                }
                this.Values[i] = 0;
            }

            //check if we are back at zero
            return !this.IsZero();
        }

        public override string ToString()
        {
            return "Dimensions: " + Dimensions + "\n" + "MultiIndex: " + Values;
        }
    }
}