LatticeMaker.cxx

Go to the documentation of this file.

// $Id: LatticeMaker.cxx,v 1.2 2001/03/02 08:19:06 west Exp $
//
// LatticeMaker
//
// Begin_Html<img src="../../pedestrians.gif" align=center>
// <a href="../source_warning.html">Warning for beginners</a>.<br>
// Also see <a href="../../root_crib/index.html">The ROOT Crib</a> and
// <a href="../index.html">The MINOS Class User Guide</a>End_Html
//
// N. West 02/2001
//
// Purpose:                                                           
// LatticeMaker is a tool to simplify Lattice building for an         
// arbitrary n:m relationship.  The user provides 2 ROOT collections  
// and an association function and the LatticeMaker build and returns 
// a Lattice.                                                         
//                                                                    
// Caution: the LatticeMakeer is not particularly efficient; it loops 
//          over all n*m combinations to fill out the Lattice.  Use   
//          LatticeBuilder for a simple 1:n Lattice.                  
// Purpose:
//

#include <string>

#include "Lattice/Lattice.h"
#include "Lattice/LatticeBuilder.h"
#include "Lattice/LatticeMaker.h"
#include "MessageService/MsgService.h"
 
ClassImp(LatticeMaker)

//   Definition of static data members
//   *********************************

CVSID("$Id: LatticeMaker.cxx,v 1.2 2001/03/02 08:19:06 west Exp $");

// Definition of member functions (alphabetical order)
// ***************************************************



//.....................................................................

Lattice* LatticeMaker::CreateLattice( const char* nameLeft,
                                      const char* nameRight,
                                      const char* type ) {

//  Purpose:   Create a new empty Lattice.
//  Arguments: 
//     nameLeft  in   Class name of objects on left side of lattice.
//     nameRight in   Class name of objects on left side of lattice.
//     type      in   Lattice type.  One of "1:n", "n:1" or "n:m" 
//                    the default is "n:m"
//            
//  Return:    
//     New empty Lattice.  The caller is responsible for deleting it.

  
//  Program Notes:-
//  =============
//
//  None.
//
//  Contact:   N. West

  string latType = type;

//  Create new Lattice supporting  1:n relationship
  if ( latType == "1:n" 
     ) return  new Lattice(nameLeft,
                           nameRight,
                           LatticeBase::LNodeMulti,
                           LatticeBase::RLinkMulti);

//  Create new Lattice supporting  n:1 relationship
  if ( latType == "n:1" 
     ) return  new Lattice(nameLeft,
                           nameRight,
                           LatticeBase::RNodeMulti,
                           LatticeBase::LLinkMulti);

//  Create new Lattice supporting full n:m relationship
  return new Lattice(nameLeft,
                     nameRight,
                     LatticeBase::LNodeMulti,
                     LatticeBase::RNodeMulti,
                     LatticeBase::LLinkMulti,
                     LatticeBase::RLinkMulti);
}                            
//.....................................................................

Lattice* LatticeMaker::CreateLattice( const TObject* objLeft,
                                      const TObject* objRight,
                                      const char* type ) {

//  Purpose:   Create a new empty Lattice.
//  Arguments: 
//     objLeft  in   Example object for left side of lattice.
//     objRight in   Example object for right side of lattice.
//     type     in   Lattice type.  One of "1:n", "n:1" or "n:m" 
//                   the default is "n:m"
//            
//  Return:    
//     New empty Lattice.  The caller is responsible for deleting it.

  
//  Program Notes:-
//  =============
//
//  objLeft and objRight are just used to get the names for the
//  two sides.
//
//  Contact:   N. West

    return CreateLattice(objLeft->ClassName(),
                         objRight->ClassName(),
                         type);

}                            
//.....................................................................

Lattice* LatticeMaker::CreateLattice(const TCollection* setLeft, 
                                     const TCollection* setRight, 
                                     AssociateFunc* asFunc,
                                     const char* type ) {

//  Purpose:   Create a new Lattice between setLeft and setRight.
//  Arguments: 
//     setLeft  in   Left set.         
//     setRight in   Right set.         
//     asFunc   in   Association function.  Returns kTRUE if entry in 
//                   first set is associated with entry in the second.
//     type     in   Lattice type.  One of "1:n", "n:1" or "n:m" 
//                   the default is "n:m"
//            
//  Return:    
//     New Lattice.  The caller is responsible for deleting it.
//                   Returns 0 if either or both sets empty.

//  Contact:   N. West

//  Check .

  TIter itrLeft(setLeft);
  TIter itrRight(setRight);
  TObject* objLeft = itrLeft();
  TObject* objRight = itrRight();

  if ( ! objLeft || ! objRight ) {
    MSG("Lat",Msg::kWarning) 
      << "Cannot build lattice; one or both sets empty," << endl;
    return 0;
  }

//  Create new Lattice.
  Lattice* lat = CreateLattice(objLeft->ClassName(),
                               objRight->ClassName(),
                               type);

  string latType = type;
  itrLeft.Reset();
  itrRight.Reset();

  if ( latType == "1:n" ) { 
    while ( (objRight = itrRight()) ){
      itrLeft.Reset();
      while ( (objLeft = itrLeft()) ) {
        if ( asFunc(objLeft,objRight) ) {
          lat->ConnectLR(objLeft,0,objRight);
          break;
        }
      }
    }

  }
  else  if ( latType == "n:1" ) { 
    while ( (objLeft = itrLeft()) ){
     itrRight.Reset();
     while ( (objRight = itrRight()) ) {
       if ( asFunc(objLeft,objRight) ) {
         lat->ConnectLR(objLeft,0,objRight);
         break;
       }
     }
    }
  }

  else { 
    while ( (objLeft = itrLeft()) ){
     itrRight.Reset();
     while ( (objRight = itrRight()) ) {
       if ( asFunc(objLeft,objRight) 
           ) lat->ConnectLR(objLeft,0,objRight);
     }
    }
  }

     
  return lat;

}                            
//.....................................................................

Lattice* LatticeMaker::Create1ToNLattice(const TCollection* setLeft, 
                                         const TCollection* setRight, 
                                         KeyFunc* leftFunc,
                                         KeyFunc* rightFunc ) {

//  Purpose:   Create a new 1:n Lattice between setLeft and setRight.
//  Arguments: 
//     setLeft   in  Left set.  
//                   Each member is associated to 1 or more of right set
//     setRight  in  Right set.       
//                   Each member is associated to 1 of left set
//     LeftFunc  in  Key function for setLeft members.
//                   Returns a unique key.
//     RightFunc in  Key function for rightSet members.
//                   Returns the unique key of the setLeft member
//                   with which this member is associated.
//            
//  Return:    
//     New Lattice.  The caller is responsible for deleting it.
//                   Returns 0 if either or both sets empty.

//  Contact:   N. West

//  Check .

  TIter itrLeft(setLeft);
  TIter itrRight(setRight);
  TObject* objLeft = itrLeft();
  TObject* objRight = itrRight();

  if ( ! objLeft || ! objRight ) {
    MSG("Lat",Msg::kWarning) 
      << "Cannot build lattice; one or both sets empty," << endl;
    return 0;
  }

//  Create new 1:n  Lattice.
  Lattice* lat = CreateLattice(objLeft->ClassName(),
                               objRight->ClassName(),
                               "1:n");

  
// Create a LatticeBuilder and dock lattice.
  LatticeBuilder builder;
  builder.DockLattice(lat, Lattice::kLeft);

//  Store the primary keys.
   itrLeft.Reset();
   while ( (objLeft = itrLeft() ) 
         )  builder.AddPrimary(leftFunc(objLeft), objLeft);

//  Connect secondaries to primary.
   itrRight.Reset();
   while ( (objRight = itrRight() ) 
         )  builder.AddSecondary(rightFunc(objRight), objRight);

  return lat;

}                            

---