/*
 * Copyright (c) 2006 Thomas Weise
 * 
 * E-Mail           : tweise@gmx.de
 * Creation Date    : 2006-06-27 14:38:59
 * Original Filename: org.dgpf.search.api.utils.IMutator.java
 * Version          : 1.0.1
 * Last modification: 2006-07-26
 *                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.search.api.utils;

import java.io.Serializable;

import org.dgpf.search.api.SearchContext;

/**
 * This interface unifies classes that are able to mutate something in a
 * randomized manner.
 * @param <Genotype>    The type of the things to be mutated.
 * @param <Contexttype> The sort of context to be used.
 * @param <Infotype>    An information object to be propagated. If no
 *                      information object is needed, just leave this
 *                      parameter <code>Object</code> and always pass in
 *                      <code>null</code>.
 * @author Thomas Weise
 */
public interface IMutator<Genotype    extends Serializable,
                          Contexttype extends SearchContext,
                          Infotype> 
  {
/**
 * Perform the mutation.
 * @param p_source  The source object to create a randomizedly altered
 *                  copy of.
 * @param p_context The context hosting the operation.
 * @param p_info    The information record.
 * @return  The new, randomizedly altered copy of the object
 *          <code>p_source</code> or <code>p_source</code> itself if no
 *          mutation was possible.
 */
  public  abstract  Genotype  mutate  (final Genotype    p_source,
                                       final Contexttype p_context,
                                       final Infotype    p_info);
  }