/*
 * Copyright (c) 2005 Thomas Weise
 *
 * E-Mail           : tweise@gmx.de
 * Creation Date    : 2005-12-12 09:02:28
 * Original Filename: org.dgpf.automaton.genetics.SequenceFactory.java
 * Version          : 2.2.1
 * Last modification: 2006-05-08
 *                by: Thomas Weise
 *
 * License          : GNU LESSER GENERAL PUBLIC LICENSE
 *                    Version 2.1, February 1999
 *                    You should have received a copy of this license along
 *                    with this library; if not, write to the Free Software
 *                    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *                    MA 02111-1307, USA or download the license under
 *                    http://www.gnu.org/copyleft/lesser.html.
 *
 * Warranty         : This software is provided "as is" without any
 *                    warranty; without even the implied warranty of
 *                    merchantability or fitness for a particular purpose.
 *                    See the Gnu Lesser General Public License for more
 *                    details.
 */

package org.dgpf.gp.automaton.search;

import org.dgpf.gp.automaton.base.Instruction;

/**
 * This abstract class allows the user to specify fixed code sequences that
 * can be pasted into code by mutation or creation operations.
 *
 * @author Thomas Weise
 */
public abstract class SequenceFactory
  {
/**
 * Create a fixed sequence of instructions.
 * @param p_context           The program context to be used.
 * @param p_instruction_count The count of instructions of the program
 *                            the new sequence will be part of.
 * @param p_memory_size   The memory size currently available.
 * @param p_position      The position where the new sequence will be
 *                        placed. Use this to align your
 *                        <code>IfJump</code>-instructions.
 * @param p_at_end        <code>true</code> if and only if the code
 *                        sequence is to be inserted at the end.
 * @return  The new, random instruction.
 */
  public abstract Instruction[] create(
                                 final ProgramContext     p_context,
                                 final int                p_instruction_count,
                                 final int                p_memory_size,
                                 final int                p_position,
                                 final boolean            p_at_end);
  }