# -*- coding: utf-8 -*-
# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License version 3 as published by the Free Software Foundation.
#
# This program 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 this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
# Contributors:
# INITIAL AUTHORS - initial API and implementation and/or initial
# documentation
# :author: Matthias De Lozzo
"""Build a diagonal DOE for scalable model construction."""
from __future__ import division, unicode_literals
import logging
from typing import Container, Dict, Optional, Union
from numpy import array, ndarray
from gemseo.algos.doe.doe_lib import DOELibrary
OptionType = Optional[Union[str, int, float, bool, Container[str]]]
LOGGER = logging.getLogger(__name__)
[docs]class DiagonalDOE(DOELibrary):
"""Class used to create a diagonal DOE."""
__ALGO_DESC = {"DiagonalDOE": "Diagonal design of experiments"}
def __init__(self): # type: (...) -> None
super(DiagonalDOE, self).__init__()
for algo, description in self.__ALGO_DESC.items():
self.lib_dict[algo] = {
DOELibrary.LIB: self.__class__.__name__,
DOELibrary.INTERNAL_NAME: algo,
DOELibrary.DESCRIPTION: description,
}
def _get_options(
self,
eval_jac=False, # type: bool
n_processes=1, # type: int
wait_time_between_samples=0.0, # type: float
n_samples=2, # type: int
reverse=None, # type: Optional[Container[str]]
max_time=0, # type: float
**kwargs # type: OptionType
): # type: (...) -> Dict[str, OptionType] # pylint: disable=W0221
"""Get the options.
Args:
eval_jac: Whether to evaluate the Jacobian.
n_processes: The number of processes.
wait_time_between samples: The waiting time between two samples.
n_samples: The number of samples.
The number of samples must be greater than or equal to 2.
reverse: The dimensions or variables to sample from their upper bounds to
their lower bounds.
If None, every dimension will be sampled from its lower bound to its
upper bound.
max_time: The maximum runtime in seconds.
If 0, no maximum runtime is set.
**kwargs: Additional arguments.
Returns:
The processed options.
"""
return self._process_options(
eval_jac=eval_jac,
n_processes=n_processes,
wait_time_between_samples=wait_time_between_samples,
n_samples=n_samples,
reverse=reverse,
max_time=max_time,
**kwargs
)
def _generate_samples(
self, **options # type: OptionType
): # type: (...) -> ndarray
"""Generate the DOE samples.
Args:
**options: The options for the algorithm,
see the associated JSON file.
Returns:
The samples.
Raises:
ValueError: If the number of samples is not set, or is lower than 2.
"""
n_samples = options.get(self.N_SAMPLES)
if n_samples is None or n_samples < 2:
raise ValueError(
"The number of samples must set to a value greater than or equal to 2."
)
reverse = options.get("reverse", [])
if reverse is None:
reverse = []
sizes = options[self._VARIABLES_SIZES]
name_by_index = {}
start = 0
for name in options[self._VARIABLES_NAMES]:
for index in range(start, start + sizes[name]):
name_by_index[index] = name
start += sizes[name]
samples = []
for index in range(options[self.DIMENSION]):
if str(index) in reverse or name_by_index[index] in reverse:
numerators = range(n_samples - 1, -1, -1)
else:
numerators = range(0, n_samples)
samples.append([numerator / (n_samples - 1.0) for numerator in numerators])
return array(samples).T
