/*
 * ProcessOnTreeDelegate.java
 *
 * Copyright (c) 2002-2016 Alexei Drummond, Andrew Rambaut and Marc Suchard
 *
 * This file is part of BEAST.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership and licensing.
 *
 * BEAST is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 *  BEAST 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with BEAST; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301  USA
 */

package dr.evomodel.treedatalikelihood;

import dr.inference.model.Model;

import java.util.List;

/**
 * DataLikelihoodDelegate - interface for a plugin delegate for the data likelihood.
 *
 * @author Andrew Rambaut
 * @author Marc Suchard
 * @version $Id$
 */
public interface ProcessOnTreeDelegate {

    TreeTraversal.TraversalType getOptimalTraversalType();

    final class BranchOperation {
        public BranchOperation(int branchNumber, double branchLength) {
            this.branchNumber = branchNumber;
            this.branchLength = branchLength;
        }

        public int getBranchNumber() {
            return branchNumber;
        }

        public double getBranchLength() {
            return branchLength;
        }

        public String toString() {
            return branchNumber + ":" + branchLength;
        }

        private final int branchNumber;
        private final double branchLength;
    }

    final class NodeOperation {
        public NodeOperation(int nodeNumber, int leftChild, int rightChild) {
            this.nodeNumber = nodeNumber;
            this.leftChild = leftChild;
            this.rightChild = rightChild;
        }

        public int getNodeNumber() {
            return nodeNumber;
        }

        public int getLeftChild() {
            return leftChild;
        }

        public int getRightChild() {
            return rightChild;
        }

        public String toString() {
            return nodeNumber + "(" + leftChild + "," + rightChild + ")";
        }

        private final int nodeNumber;
        private final int leftChild;
        private final int rightChild;
    }

    final class BranchNodeOperation {
        public BranchNodeOperation(int nodeNumber, int parentNumber, double branchLength) {
            this.nodeNumber = nodeNumber;
            this.parentNumber = parentNumber;
            this.branchLength = branchLength;
        }

        public int getNodeNumber() {
            return nodeNumber;
        }

        public int getParentNumber() { return parentNumber; }

        public double getBranchLength() { return branchLength; }

        public String toString() {
            return nodeNumber + "(" + parentNumber + "):" + branchLength;
        }

        private final int nodeNumber;
        private final int parentNumber;
        private final double branchLength;
    }

    final class Utils {

        static <T> String toString(List<T> operations) {
            StringBuilder sb = new StringBuilder();
            for (T op : operations) {
                sb.append(op.toString()).append("\n");
            }
            return sb.toString();
        }
    }
}