scheduler.h

Go to the documentation of this file.

// Copyright 2010-2024 Google LLC
// 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.
 
#ifndef PDLP_SCHEDULER_H_
#define PDLP_SCHEDULER_H_
 
#include <string>
 
#include "absl/functional/any_invocable.h"
 
namespace operations_research::pdlp {
 
// Thread scheduling interface.
class Scheduler {
 public:
  virtual ~Scheduler() = default;
  virtual int num_threads() const = 0;
  virtual std::string info_string() const = 0;
 
  // Calls `do_func(i)` in parallel for `i` from `start` to `end-1`.
  virtual void ParallelFor(int start, int end,
                           absl::AnyInvocable<void(int)> do_func) = 0;
};
 
}  // namespace operations_research::pdlp
 
#endif  // PDLP_SCHEDULER_H_