Parallel2DExecutor.h

Go to the documentation of this file.

#ifndef SimTK_SimTKCOMMON_PARALLEL_2D_EXECUTOR_H_
#define SimTK_SimTKCOMMON_PARALLEL_2D_EXECUTOR_H_

/* -------------------------------------------------------------------------- *
 *                       Simbody(tm): SimTKcommon                             *
 * -------------------------------------------------------------------------- *
 * This is part of the SimTK biosimulation toolkit originating from           *
 * Simbios, the NIH National Center for Physics-Based Simulation of           *
 * Biological Structures at Stanford, funded under the NIH Roadmap for        *
 * Medical Research, grant U54 GM072970. See https://simtk.org/home/simbody.  *
 *                                                                            *
 * Portions copyright (c) 2008-12 Stanford University and the Authors.        *
 * Authors: Peter Eastman                                                     *
 * Contributors:                                                              *
 *                                                                            *
 * Licensed 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.                                             *
 * -------------------------------------------------------------------------- */

#include "ParallelExecutor.h"
#include "PrivateImplementation.h"

namespace SimTK {

class Parallel2DExecutor;
class Parallel2DExecutorImpl;

// We only want the template instantiation to occur once. This symbol is defined in the SimTK core
// compilation unit that defines the Parallel2DExecutor class but should not be defined any other time.
#ifndef SimTK_SIMTKCOMMON_DEFINING_PARALLEL_2D_EXECUTOR
    extern template class PIMPLHandle<Parallel2DExecutor, Parallel2DExecutorImpl>;
#endif

class SimTK_SimTKCOMMON_EXPORT Parallel2DExecutor : public PIMPLHandle<Parallel2DExecutor, Parallel2DExecutorImpl> {
public:
    class Task;
    enum RangeType {FullMatrix, HalfMatrix, HalfPlusDiagonal};
    explicit Parallel2DExecutor(int gridSize, int numThreads = ParallelExecutor::getNumProcessors());
    Parallel2DExecutor(int gridSize, ParallelExecutor& executor);
    void execute(Task& task, RangeType rangeType);
    ParallelExecutor& getExecutor();
};

class Parallel2DExecutor::Task {
public:
    virtual ~Task() {
    }
    virtual void execute(int i, int j) = 0;
    virtual void initialize() {
    }
    virtual void finish() {
    }
};

} // namespace SimTK

#endif // SimTK_SimTKCOMMON_PARALLEL_2D_EXECUTOR_H_