src/lib/solution.h

Go to the documentation of this file.

/* BurrTools
 *
 * BurrTools is the legal property of its developers, whose
 * names are listed in the COPYRIGHT file, which is included
 * within the source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * 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 General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
#ifndef __SOLUTION_H__
#define __SOLUTION_H__

class assembly_c;
class separation_c;
class separationInfo_c;
class xmlParser_c;
class xmlWriter_c;
class gridType_c;
class disassembly_c;

class solution_c
{
  /* the assembly contains the pieces so that they
   * do assemble into the result shape */
  assembly_c * assembly;

  /* the disassembly tree, only not NULL, if we
   * have disassembled the puzzle
   */
  separation_c * tree;

  /* if no separation is given, maybe we have a separationInfo
   * that contains only some of the information of a full separation
   * but requires a lot less memory
   */
  separationInfo_c * treeInfo;

  /* as it is now possible to not save all solutions
   * it might be useful to know the exact number and sequence
   * how solutions were found
   *
   * solutionNum is 0, when no disassembly is known
   */
  unsigned int assemblyNum;
  unsigned int solutionNum;

public:

  solution_c(assembly_c * assm, unsigned int assmNum, separation_c * t, unsigned int solNum) :
    assembly(assm), tree(t), treeInfo(0), assemblyNum(assmNum), solutionNum(solNum) {}

  solution_c(assembly_c * assm, unsigned int assmNum, separationInfo_c * ti, unsigned int solNum) :
    assembly(assm), tree(0), treeInfo(ti), assemblyNum(assmNum), solutionNum(solNum) {}

  solution_c(assembly_c * assm, unsigned int assmNum) :
    assembly(assm), tree(0), treeInfo(0), assemblyNum(assmNum), solutionNum(0) {}

  solution_c(xmlParser_c & pars, unsigned int pieces, const gridType_c * gt);

  ~solution_c(void);

  void save(xmlWriter_c & xml) const;

  assembly_c * getAssembly(void) { return assembly; }
  const assembly_c * getAssembly(void) const { return assembly; }

  separation_c * getDisassembly(void) { return tree; }
  const separation_c * getDisassembly(void) const { return tree; }

  disassembly_c * getDisassemblyInfo(void);
  const disassembly_c * getDisassemblyInfo(void) const;

  unsigned int getAssemblyNumber(void) const { return assemblyNum; }
  unsigned int getSolutionNumber(void) const { return solutionNum; }

  void removeDisassembly(void);
  void setDisassembly(separation_c * sep);

  void exchangeShape(unsigned int s1, unsigned int s2);

  void removePieces(unsigned int start, unsigned int count);

  void addNonPlacedPieces(unsigned int start, unsigned int count);
};

#endif

---