Skip to content

Commit a24e0d4

Browse files
committed
Improve comments
1 parent 7efab86 commit a24e0d4

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

ego/src/mixint.rs

+6-2
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,7 @@ impl<F: Float, S: egobox_doe::SamplingMethod<F>> MixintSampling<F, S> {
234234
}
235235

236236
/// Sets whether we want to work in folded space
237+
/// If set, sampling data will be provided in folded space
237238
pub fn work_in_folded_space(&mut self, output_in_folded_space: bool) -> &mut Self {
238239
self.output_in_folded_space = output_in_folded_space;
239240
self
@@ -279,7 +280,8 @@ pub struct MixintMoeValidParams {
279280
}
280281

281282
impl MixintMoeValidParams {
282-
/// Sets whether we want to work in folded space
283+
/// Sets whether we want to work in folded space that is whether
284+
/// If set, input training data has to be given in folded space
283285
pub fn work_in_folded_space(&self) -> bool {
284286
self.work_in_folded_space
285287
}
@@ -478,7 +480,7 @@ pub struct MixintMoe {
478480
moe: Moe,
479481
/// The input specifications
480482
xtypes: Vec<XType>,
481-
/// whether data are in given in folded space (enum indexes) or not (enum masks)
483+
/// whether training input data are in given in folded space (enum indexes) or not (enum masks)
482484
/// i.e for "blue" in ["red", "green", "blue"] either \[2\] or [0, 0, 1]
483485
work_in_folded_space: bool,
484486
}
@@ -623,11 +625,13 @@ pub struct MixintContext {
623625
xtypes: Vec<XType>,
624626
/// whether data are in given in folded space (enum indexes) or not (enum masks)
625627
/// i.e for "blue" in ["red", "green", "blue"] either \[2\] or [0, 0, 1]
628+
/// For sampling data refers to DOE data. For surrogate data refers to training input data
626629
work_in_folded_space: bool,
627630
}
628631

629632
impl MixintContext {
630633
/// Constructor with given `xtypes` specification
634+
/// where working in folded space is the default
631635
pub fn new(xtypes: &[XType]) -> Self {
632636
MixintContext {
633637
xtypes: xtypes.to_vec(),

0 commit comments

Comments
 (0)