sudoku.h 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. /*====================================================================*
  2. - Copyright (C) 2001 Leptonica. All rights reserved.
  3. -
  4. - Redistribution and use in source and binary forms, with or without
  5. - modification, are permitted provided that the following conditions
  6. - are met:
  7. - 1. Redistributions of source code must retain the above copyright
  8. - notice, this list of conditions and the following disclaimer.
  9. - 2. Redistributions in binary form must reproduce the above
  10. - copyright notice, this list of conditions and the following
  11. - disclaimer in the documentation and/or other materials
  12. - provided with the distribution.
  13. -
  14. - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15. - ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16. - LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17. - A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANY
  18. - CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19. - EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20. - PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21. - PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22. - OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  23. - NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  24. - SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25. *====================================================================*/
  26. #ifndef SUDOKU_H_INCLUDED
  27. #define SUDOKU_H_INCLUDED
  28. /*!
  29. * \file sudoku.h
  30. *
  31. * <pre>
  32. * The L_Sudoku holds all the information of the current state.
  33. *
  34. * The input to sudokuCreate() is a file with any number of lines
  35. * starting with '#', followed by 9 lines consisting of 9 numbers
  36. * in each line. These have the known values and use 0 for the unknowns.
  37. * Blank lines are ignored.
  38. *
  39. * The %locs array holds the indices of the unknowns, numbered
  40. * left-to-right and top-to-bottom from 0 to 80. The array size
  41. * is initialized to %num. %current is the index into the %locs
  42. * array of the current guess: locs[current].
  43. *
  44. * The %state array is used to determine the validity of each guess.
  45. * It is of size 81, and is initialized by setting the unknowns to 0
  46. * and the knowns to their input values.
  47. * </pre>
  48. */
  49. struct L_Sudoku
  50. {
  51. l_int32 num; /*!< number of unknowns */
  52. l_int32 *locs; /*!< location of unknowns */
  53. l_int32 current; /*!< index into %locs of current location */
  54. l_int32 *init; /*!< initial state, with 0 representing */
  55. /*!< the unknowns */
  56. l_int32 *state; /*!< present state, including inits and */
  57. /*!< guesses of unknowns up to %current */
  58. l_int32 nguess; /*!< shows current number of guesses */
  59. l_int32 finished; /*!< set to 1 when solved */
  60. l_int32 failure; /*!< set to 1 if no solution is possible */
  61. };
  62. typedef struct L_Sudoku L_SUDOKU;
  63. /*! For printing out array data */
  64. enum {
  65. L_SUDOKU_INIT = 0,
  66. L_SUDOKU_STATE = 1
  67. };
  68. #endif /* SUDOKU_H_INCLUDED */