Skip to content

Initial docs in preparation for registration. - #4

Merged
apozharski merged 11 commits into
masterfrom
ap/docs
Jul 17, 2026
Merged

Initial docs in preparation for registration.#4
apozharski merged 11 commits into
masterfrom
ap/docs

Conversation

@apozharski

Copy link
Copy Markdown
Member

No description provided.

@apozharski
apozharski requested a review from frapac July 13, 2026 15:08
@apozharski

Copy link
Copy Markdown
Member Author

Docs deploy correctly now, here is the preview https://madsuite.org/MPCCModels.jl/previews/PR4/

@frapac frapac left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall LGTM!

Comment thread docs/src/api.md Outdated
Comment thread docs/src/api.md Outdated
```
along with three vectors `ind_cc1`, `ind_cc2`, and `cc_types`.
We encode the functions ``G(x)`` and ``H(x)`` via these vectors in the following way.
The vectors `ind_cc1` and `ind_cc2` correspond to indexes into the vectors ``x`` and ``c'(x)``.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I would detail what do ind_cc1 and ind_cc2 encode depending on cc_types using three different bullet points.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm, I am not sure what you mean. I think I like the table, but I am open to changing it.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep the table then!

Comment thread docs/src/api.md Outdated
Comment thread docs/src/api.md Outdated
@apozharski
apozharski requested a review from frapac July 17, 2026 13:21
Comment thread docs/src/api.md Outdated
```
along with three vectors `ind_cc1`, `ind_cc2`, and `cc_types`.
We encode the functions ``G(x)`` and ``H(x)`` via these vectors in the following way.
The vectors `ind_cc1` and `ind_cc2` correspond to indexes into the vectors ``x`` and ``c'(x)``.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep the table then!

@apozharski
apozharski merged commit 889bc11 into master Jul 17, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants