algorithm_registry.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// Copyright (C) 2021 CERN & University of Surrey for the benefit of the
// BioDynaMo collaboration. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
//
// See the LICENSE file distributed with this work for details.
// See the NOTICE file distributed with this work for additional information
// regarding copyright ownership.
//
// -----------------------------------------------------------------------------
 
#ifndef CORE_MULTI_SIMULATION_ALGORITHM_ALGORITHM_REGISTRY_H_
#define CORE_MULTI_SIMULATION_ALGORITHM_ALGORITHM_REGISTRY_H_
 
#include <unordered_map>
 
#include "core/multi_simulation/algorithm/algorithm.h"
#include "core/multi_simulation/optimization_param.h"
#include "core/param/param.h"
 
namespace bdm {
namespace experimental {
 
class MultiSimulationManager;
 
struct AlgorithmRegistry {
  static AlgorithmRegistry *GetInstance();
 
  Algorithm *GetAlgorithm(const std::string &algo_name);
 
  bool AddAlgorithm(const std::string &algo_name, Algorithm *algo);
 
 private:
  std::unordered_map<std::string, Algorithm *> algorithms_;
 
  AlgorithmRegistry();
  ~AlgorithmRegistry();
};
 
#define BDM_REGISTER_ALGO(op) \
  bool op::registered_ =      \
      AlgorithmRegistry::GetInstance()->AddAlgorithm(#op, new op());
 
#define BDM_ALGO_HEADER() \
 private:                 \
  static bool registered_;
 
// Get Optimization Algorithm from registry
inline Algorithm *CreateOptimizationAlgorithm(OptimizationParam *opt_params) {
  // Check if the parameters are initialized correctly
  for (auto param : opt_params->params) {
    param->Validate();
  }
  auto ret =
      AlgorithmRegistry::GetInstance()->GetAlgorithm(opt_params->algorithm);
  return ret;
}
 
}  // namespace experimental
}  // namespace bdm
 
#endif  // CORE_MULTI_SIMULATION_ALGORITHM_ALGORITHM_REGISTRY_H_