eic-opticks/sysrap/STranche.hh

0001 /*
0002  * Copyright (c) 2019 Opticks Team. All Rights Reserved.
0003  *
0004  * This file is part of Opticks
0005  * (see https://bitbucket.org/simoncblyth/opticks).
0006  *
0007  * Licensed under the Apache License, Version 2.0 (the "License");
0008  * you may not use this file except in compliance with the License.
0009  * You may obtain a copy of the License at
0010  *
0011  *   http://www.apache.org/licenses/LICENSE-2.0
0012  *
0013  * Unless required by applicable law or agreed to in writing, software
0014  * distributed under the License is distributed on an "AS IS" BASIS,
0015  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0016  * See the License for the specific language governing permissions and
0017  * limitations under the License.
0018  */
0019
0020 #pragma once
0021 #include "SYSRAP_API_EXPORT.hh"
0022
0023 /**
0024 STranche
0025 =========
0026
0027 Split *total* into tranches of mostly equal *max_tranche* sizes,
0028 except the remainder in the last tranche.
0029
0030 **/
0031
0032 struct SYSRAP_API STranche
0033 {
0034     STranche(unsigned total_, unsigned max_tranche_) ;
0035
0036     unsigned tranche_size(unsigned i) const ;
0037     unsigned global_index(unsigned i, unsigned j) const ;
0038     const char* desc() const ;
0039     void dump(const char* msg="STranche::dump");
0040
0041     unsigned total ;
0042     unsigned max_tranche ;
0043     unsigned num_tranche ;
0044     unsigned last_tranche ;
0045
0046 };
0047
0048
0049