org.apache.maven.mercury.metadata.sat.SatContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mercury-md-sat Show documentation
The newest version!
/**
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.apache.maven.mercury.metadata.sat;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.maven.mercury.artifact.ArtifactMetadata;
import org.apache.maven.mercury.artifact.MetadataTreeNode;
import org.apache.maven.mercury.logging.IMercuryLogger;
import org.apache.maven.mercury.logging.MercuryLoggerManager;
import org.codehaus.plexus.lang.DefaultLanguage;
import org.codehaus.plexus.lang.Language;

 /**
  * This class hold all variables fed to the SAT solver. Because of the
  * tree unwinding algorithm all pivots (optional nodes) should be supplied first 
  * 
  * @author Oleg Gusakov
  */
class SatContext
{
  private static final Language LANG = new DefaultLanguage(SatContext.class);
  private static final IMercuryLogger LOG = MercuryLoggerManager.getLogger( SatContext.class );

  Map variables;
  //-----------------------------------------------------------------------
  public SatContext( int estimatedTreeSize )
  {
    variables = new HashMap( estimatedTreeSize );
  }
  //-----------------------------------------------------------------------
  public SatVar findOrAdd( MetadataTreeNode n )
  throws SatException
  {
    if( n == null )
      throw new SatException( "cannot create a literal out of a null metadata: "+n );
    
    SatVar var = variables.get( n );
    
    if( var != null )
    {
      if( LOG.isDebugEnabled() )
        LOG.debug( var.toString() );
      return var;
    }
    
    var = new SatVar( n );
    variables.put( n, var );
    
  if( LOG.isDebugEnabled() )
    LOG.debug( var.toString() );

    return var; 
  }
  //-----------------------------------------------------------------------
  public ArtifactMetadata getMd( int literal )
  {
    for( SatVar v : variables.values() )
      if( v._literal == literal )
        return v.getMd();
    
    return null;
  }
  //-----------------------------------------------------------------------
  private static final boolean isSolution( int m, int [] model )
  {
    for( int mm : model )
      if( mm == m )
        return true;
    
    return false;
  }
  //-----------------------------------------------------------------------
  public MetadataTreeNode getSolutionSubtree( MetadataTreeNode tree, int [] model )
  {
    if( tree == null )
      throw new IllegalArgumentException( LANG.getMessage( "null.tree" ) );
    
    if( tree.getMd() == null )
      throw new IllegalArgumentException( LANG.getMessage( "null.tree.md" ) );
    
    if( model == null )
      throw new IllegalArgumentException( LANG.getMessage( "null.model" ) );
    
    if( model.length < 1 )
      throw new IllegalArgumentException( LANG.getMessage( "empty.model" ) );
    
    int sz = 0;
    
    for( int m : model )
      if( m > 0 )
        ++sz;
      
    if( sz == 0)
      return null;
    
    MetadataTreeNode res = MetadataTreeNode.deepCopy( tree );
    
    cleanTree( res, model );
    
    return res;
  }
  //-----------------------------------------------------------------------
  private static final void cleanTree( MetadataTreeNode tn, int [] model )
  {
    if( ! tn.hasChildren() )
      return;
    
    List badKids = new ArrayList();
    
    for( MetadataTreeNode kid : tn.getChildren() )
      if( ! isSolution( kid.getId(), model ) )
        badKids.add( kid );
      
    tn.getChildren().removeAll( badKids );
      
    if( ! tn.hasChildren() )
      return;
      
    for( MetadataTreeNode kid : tn.getChildren() )
      cleanTree( kid, model );
  }
  //-----------------------------------------------------------------------
//  @Override
//  public String toString()
//  {
//    if(varCount < 1)
//      return "";
//    StringBuilder sb = new StringBuilder( 32*varCount );
//    char comma = '[';
//    
//    for( SatVar var : variables )
//    {
//      sb.append(comma+" x"+var._literal+"="+var._md.toString() );
//      comma = ',';
//    }
//    return sb.toString()+']';
//  }
  //-----------------------------------------------------------------------
  //-----------------------------------------------------------------------
}