org.chocosolver.solver.trace.CPProfiler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of choco-solver Show documentation
Open-source constraint solver.
There is a newer version: 4.10.17
/*
 * This file is part of choco-solver, http://choco-solver.org/
 *
 * Copyright (c) 2022, IMT Atlantique. All rights reserved.
 *
 * Licensed under the BSD 4-clause license.
 *
 * See LICENSE file in the project root for full license information.
 */
package org.chocosolver.solver.trace;

import com.github.cpprofiler.Connector;

import org.chocosolver.solver.Solver;

import java.io.Closeable;
import java.io.IOException;

/**
 * A search monitor to send data to cp-profiler.
 * It enables to profile and to visualize Constraint Programming. An installation is needed and is
 * described here. This monitor relies on
 * its java integration.  Note that
 * CPProfiler is {@link Closeable} and can be used as follow: 

 * 
 {@code
 * Model model = ProblemMaker.makeCostasArrays(7);
 *  try (CPProfiler profiler = new CPProfiler(model)) {
 *      while (model.getSolver().solve()) ;
 *      out.println(model.getSolver().getSolutionCount());
 * }
 * }
 *   Created by cprudhom on 22/10/2015. Project: choco.
 *
 * @author Charles Prud'homme
 * @since 3.3.2
 */
public class CPProfiler extends SearchViz {

    /**
     * Used to communicate every node
     */
    private Connector connector;

    /**
     * Active connection to cp-profiler.
     * This requires cp-profiler to be installed and launched before.
     *
     * @param aSolver     solver to observe resolution
     * @param sendDomain set to true to send domain into 'info' field (beware, it can
     *                   increase the memory consumption and slow down the overall execution), set
     *                   to false otherwise.
     */
    public CPProfiler(Solver aSolver, boolean sendDomain) {
        super(aSolver, sendDomain);
    }

    @Override
    protected boolean connect(String label) {
        if(connector == null){
            connector = new Connector();
        }
        try {
            connector.connect(6565); // 6565 is the port used by cpprofiler by default
            connector.restart(label, 0); // starting a new tree (also used in case of a restart)
        } catch (IOException e) {
            System.err.println("Unable to connect to CPProfiler, make sure it is started. No information will be sent.");
            return false;
        }
        return true;
    }

    @Override
    protected void disconnect(){
        if(connected) {
            try {
                connector.disconnect();
            } catch (IOException e) {
                System.err.println("Unable to disconnect CPProfiler.");
            }
        }
    }

    @Override
    protected void sendNode(int nc, int pid, int alt, int kid, int rid, String label, String info) {
        send(nc, pid, alt, kid, rid, Connector.NodeStatus.BRANCH, label, info);
    }

    @Override
    protected void sendSolution(int nc, int pid, int alt, int kid, int rid, String label, String info) {
        send(nc, pid, alt, kid, rid, Connector.NodeStatus.SOLVED, label, info);
    }

    @Override
    protected void sendFailure(int nc, int pid, int alt, int kid, int rid, String label, String info) {
        send(nc, pid, alt, kid, rid, Connector.NodeStatus.FAILED, label, info);
    }

    @Override
    protected void sendRestart(int rid) {
        try {
            connector.restart(rid);
        } catch (IOException e) {
            System.err.println("Lost connection with CPProfiler. No more information will be sent.");
            connected = false;
        }
    }

    private void send(int nc, int pid, int alt, int kid, int rid, Connector.NodeStatus status, String label, String info) {
        try {
            connector.createNode(nc, pid, alt, kid, status)
                    .setRestartId(rid)
                    .setLabel(label)
                    .setInfo(info)
                    .send();
        } catch (IOException e) {
            System.err.println("Lost connection with CPProfiler. No more information will be sent.");
            connected = false;
        }
    }
}