{-|

Module      : Abacus
Description : Core functionality for a simple abacus program
Copyright   : (C) Jonathan Lamothe
License     : AGPL-3.0-or-later
Maintainer  : jonathan@jlamothe.net
Stability   : experimental
Portability : POSIX

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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
Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public
License along with this program.  If not, see
<https://www.gnu.org/licenses/>.

-}

module Abacus (Abacus, newAbacus) where

import Abacus.Internal

-- | Constructs the initial state of a new "Abacus"
newAbacus
  :: Int
  -- ^ The number of beads on each rung
  -> Int
  -- ^ The number of rungs
  -> Maybe Abacus
newAbacus = undefined

--jl