Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Report option value changed when running from command line. #2134

Merged
merged 1 commit into from
Jan 15, 2025
Merged

Report option value changed when running from command line. #2134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion app/HighsRuntimeOptions.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ bool loadOptions(const HighsLogOptions& report_log_options, int argc,
case HighsLoadOptionsStatus::kError:
return false;
case HighsLoadOptionsStatus::kEmpty:
writeOptionsToFile(stdout, options.records);
writeOptionsToFile(stdout, options.log_options, options.records);
return false;
default:
break;
Expand Down
1 change: 1 addition & 0 deletions app/RunHighs.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ int main(int argc, char** argv) {
// settings defined in any options file.
highs.passOptions(loaded_options);
// highs.writeOptions("Options.md");
highs.writeOptions("", true);

// Load the model from model_file
HighsStatus read_status = highs.readModel(model_file);
Expand Down
8 changes: 4 additions & 4 deletions check/TestOptions.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ TEST_CASE("internal-options", "[highs_options]") {
REQUIRE(options.small_matrix_value == 0.001);
REQUIRE(options.mps_parser_type_free);

if (dev_run) reportOptions(stdout, options.records, true);
if (dev_run) reportOptions(stdout, report_log_options, options.records, true);

return_status = checkOptions(report_log_options, options.records);
REQUIRE(return_status == OptionStatus::kOk);
Expand Down Expand Up @@ -157,7 +157,7 @@ TEST_CASE("internal-options", "[highs_options]") {

if (dev_run) {
printf("\nAfter setting allowed_matrix_scale_factor to 1\n");
reportOptions(stdout, options.records);
reportOptions(stdout, report_log_options, options.records);
}

double allowed_matrix_scale_factor_double = 1e-7;
Expand All @@ -174,7 +174,7 @@ TEST_CASE("internal-options", "[highs_options]") {

if (dev_run) {
printf("\nAfter testing HighsInt options\n");
reportOptions(stdout, options.records);
reportOptions(stdout, report_log_options, options.records);
}

// Check setting double options
Expand Down Expand Up @@ -231,7 +231,7 @@ TEST_CASE("internal-options", "[highs_options]") {
options.log_options, options.records, model_file);
REQUIRE(return_status == OptionStatus::kUnknownOption);

if (dev_run) reportOptions(stdout, options.records);
if (dev_run) reportOptions(stdout, report_log_options, options.records);

bool get_mps_parser_type_free;
return_status =
Expand Down
6 changes: 3 additions & 3 deletions src/Highs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,11 +312,11 @@ class Highs {

/**
* @brief Write (deviations from default values of) the options to a
* file, with the extension ".html" producing HTML, otherwise using
* the standard format used to read options from a file.
* file, using the standard format used to read options from a file.
* Possible to write only deviations from default values.
*/
HighsStatus writeOptions(const std::string& filename, //!< The filename
const bool report_only_deviations = false) const;
const bool report_only_deviations = false);

/**
* @brief Returns the number of user-settable options
Expand Down
14 changes: 8 additions & 6 deletions src/lp_data/Highs.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,8 @@ HighsStatus Highs::resetOptions() {
}

HighsStatus Highs::writeOptions(const std::string& filename,
const bool report_only_deviations) const {
const bool report_only_deviations) {
this->logHeader();
HighsStatus return_status = HighsStatus::kOk;
FILE* file;
HighsFileType file_type;
Expand All @@ -148,15 +149,16 @@ HighsStatus Highs::writeOptions(const std::string& filename,
openWriteFile(filename, "writeOptions", file, file_type), return_status,
"openWriteFile");
if (return_status == HighsStatus::kError) return return_status;
if (filename == "") file_type = HighsFileType::kMinimal;
// Report to user that options are being written to a file
if (filename != "")
highsLogUser(options_.log_options, HighsLogType::kInfo,
"Writing the option values to %s\n", filename.c_str());
return_status =
interpretCallStatus(options_.log_options,
writeOptionsToFile(file, options_.records,
report_only_deviations, file_type),
return_status, "writeOptionsToFile");
return_status = interpretCallStatus(
options_.log_options,
writeOptionsToFile(file, options_.log_options, options_.records,
report_only_deviations, file_type),
return_status, "writeOptionsToFile");
if (file != stdout) fclose(file);
return return_status;
}
Expand Down
88 changes: 61 additions & 27 deletions src/lp_data/HighsOptions.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -811,15 +811,17 @@ void resetLocalOptions(std::vector<OptionRecord*>& option_records) {
}
}

HighsStatus writeOptionsToFile(FILE* file,
HighsStatus writeOptionsToFile(FILE* file, const HighsLogOptions& log_options,
const std::vector<OptionRecord*>& option_records,
const bool report_only_deviations,
const HighsFileType file_type) {
reportOptions(file, option_records, report_only_deviations, file_type);
reportOptions(file, log_options, option_records, report_only_deviations,
file_type);
return HighsStatus::kOk;
}

void reportOptions(FILE* file, const std::vector<OptionRecord*>& option_records,
void reportOptions(FILE* file, const HighsLogOptions& log_options,
const std::vector<OptionRecord*>& option_records,
const bool report_only_deviations,
const HighsFileType file_type) {
HighsInt num_options = option_records.size();
Expand All @@ -831,22 +833,27 @@ void reportOptions(FILE* file, const std::vector<OptionRecord*>& option_records,
if (!kAdvancedInDocumentation) continue;
}
if (type == HighsOptionType::kBool) {
reportOption(file, ((OptionRecordBool*)option_records[index])[0],
reportOption(file, log_options,
((OptionRecordBool*)option_records[index])[0],
report_only_deviations, file_type);
} else if (type == HighsOptionType::kInt) {
reportOption(file, ((OptionRecordInt*)option_records[index])[0],
reportOption(file, log_options,
((OptionRecordInt*)option_records[index])[0],
report_only_deviations, file_type);
} else if (type == HighsOptionType::kDouble) {
reportOption(file, ((OptionRecordDouble*)option_records[index])[0],
reportOption(file, log_options,
((OptionRecordDouble*)option_records[index])[0],
report_only_deviations, file_type);
} else {
reportOption(file, ((OptionRecordString*)option_records[index])[0],
reportOption(file, log_options,
((OptionRecordString*)option_records[index])[0],
report_only_deviations, file_type);
}
}
}

void reportOption(FILE* file, const OptionRecordBool& option,
void reportOption(FILE* file, const HighsLogOptions& log_options,
const OptionRecordBool& option,
const bool report_only_deviations,
const HighsFileType file_type) {
if (!report_only_deviations || option.default_value != *option.value) {
Expand All @@ -865,40 +872,53 @@ void reportOption(FILE* file, const OptionRecordBool& option,
fprintf(file, "%s = %s\n", option.name.c_str(),
highsBoolToString(*option.value).c_str());
} else {
fprintf(file, "%s = %s\n", option.name.c_str(),
highsBoolToString(*option.value).c_str());
std::string line =
highsFormatToString("Set option %s to %s\n", option.name.c_str(),
highsBoolToString(*option.value).c_str());
if (file == stdout) {
highsLogUser(log_options, HighsLogType::kInfo, "%s", line.c_str());
} else {
fprintf(file, "%s", line.c_str());
}
}
}
}

void reportOption(FILE* file, const OptionRecordInt& option,
void reportOption(FILE* file, const HighsLogOptions& log_options,
const OptionRecordInt& option,
const bool report_only_deviations,
const HighsFileType file_type) {
if (!report_only_deviations || option.default_value != *option.value) {
if (file_type == HighsFileType::kMd) {
fprintf(file,
"## %s\n- %s\n- Type: integer\n- Range: {%" HIGHSINT_FORMAT
", %" HIGHSINT_FORMAT "}\n- Default: %" HIGHSINT_FORMAT "\n\n",
highsInsertMdEscapes(option.name).c_str(),
highsInsertMdEscapes(option.description).c_str(),
option.lower_bound, option.upper_bound, option.default_value);
fprintf(
file,
"## %s\n- %s\n- Type: integer\n- Range: {%d, %d}\n- Default: %d\n\n",
highsInsertMdEscapes(option.name).c_str(),
highsInsertMdEscapes(option.description).c_str(),
int(option.lower_bound), int(option.upper_bound),
int(option.default_value));
} else if (file_type == HighsFileType::kFull) {
fprintf(file, "\n# %s\n", option.description.c_str());
fprintf(file,
"# [type: integer, advanced: %s, range: {%" HIGHSINT_FORMAT
", %" HIGHSINT_FORMAT "}, default: %" HIGHSINT_FORMAT "]\n",
", %d}, default: %d]\n",
highsBoolToString(option.advanced).c_str(), option.lower_bound,
option.upper_bound, option.default_value);
fprintf(file, "%s = %" HIGHSINT_FORMAT "\n", option.name.c_str(),
*option.value);
int(option.upper_bound), int(option.default_value));
fprintf(file, "%s = %d\n", option.name.c_str(), int(*option.value));
} else {
fprintf(file, "%s = %" HIGHSINT_FORMAT "\n", option.name.c_str(),
*option.value);
std::string line = highsFormatToString(
"Set option %s to %d\n", option.name.c_str(), int(*option.value));
if (file == stdout) {
highsLogUser(log_options, HighsLogType::kInfo, "%s", line.c_str());
} else {
fprintf(file, "%s", line.c_str());
}
}
}
}

void reportOption(FILE* file, const OptionRecordDouble& option,
void reportOption(FILE* file, const HighsLogOptions& log_options,
const OptionRecordDouble& option,
const bool report_only_deviations,
const HighsFileType file_type) {
if (!report_only_deviations || option.default_value != *option.value) {
Expand All @@ -917,12 +937,19 @@ void reportOption(FILE* file, const OptionRecordDouble& option,
option.upper_bound, option.default_value);
fprintf(file, "%s = %g\n", option.name.c_str(), *option.value);
} else {
fprintf(file, "%s = %g\n", option.name.c_str(), *option.value);
std::string line = highsFormatToString(
"Set option %s to %g\n", option.name.c_str(), *option.value);
if (file == stdout) {
highsLogUser(log_options, HighsLogType::kInfo, "%s", line.c_str());
} else {
fprintf(file, "%s", line.c_str());
}
}
}
}

void reportOption(FILE* file, const OptionRecordString& option,
void reportOption(FILE* file, const HighsLogOptions& log_options,
const OptionRecordString& option,
const bool report_only_deviations,
const HighsFileType file_type) {
// Don't report for the options file if writing to an options file
Expand All @@ -943,7 +970,14 @@ void reportOption(FILE* file, const OptionRecordString& option,
option.default_value.c_str());
fprintf(file, "%s = %s\n", option.name.c_str(), (*option.value).c_str());
} else {
fprintf(file, "%s = %s\n", option.name.c_str(), (*option.value).c_str());
std::string line =
highsFormatToString("Set option %s to \"%s\"\n", option.name.c_str(),
(*option.value).c_str());
if (file == stdout) {
highsLogUser(log_options, HighsLogType::kInfo, "%s", line.c_str());
} else {
fprintf(file, "%s", line.c_str());
}
}
}
}
Expand Down
18 changes: 12 additions & 6 deletions src/lp_data/HighsOptions.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,22 +233,28 @@ OptionStatus getLocalOptionType(
void resetLocalOptions(std::vector<OptionRecord*>& option_records);

HighsStatus writeOptionsToFile(
FILE* file, const std::vector<OptionRecord*>& option_records,
FILE* file, const HighsLogOptions& report_log_options,
const std::vector<OptionRecord*>& option_records,
const bool report_only_deviations = false,
const HighsFileType file_type = HighsFileType::kFull);
void reportOptions(FILE* file, const std::vector<OptionRecord*>& option_records,
void reportOptions(FILE* file, const HighsLogOptions& report_log_options,
const std::vector<OptionRecord*>& option_records,
const bool report_only_deviations = false,
const HighsFileType file_type = HighsFileType::kFull);
void reportOption(FILE* file, const OptionRecordBool& option,
void reportOption(FILE* file, const HighsLogOptions& report_log_options,
const OptionRecordBool& option,
const bool report_only_deviations,
const HighsFileType file_type);
void reportOption(FILE* file, const OptionRecordInt& option,
void reportOption(FILE* file, const HighsLogOptions& report_log_options,
const OptionRecordInt& option,
const bool report_only_deviations,
const HighsFileType file_type);
void reportOption(FILE* file, const OptionRecordDouble& option,
void reportOption(FILE* file, const HighsLogOptions& report_log_options,
const OptionRecordDouble& option,
const bool report_only_deviations,
const HighsFileType file_type);
void reportOption(FILE* file, const OptionRecordString& option,
void reportOption(FILE* file, const HighsLogOptions& report_log_options,
const OptionRecordString& option,
const bool report_only_deviations,
const HighsFileType file_type);

Expand Down
Loading