Documentation fixes

Author: mmghannam

src/model.rs

@@ -162,7 +162,7 @@ impl Model<ProblemCreated> {
     ///
     /// # Returns
     ///
-    /// A reference-counted pointer to the new variable.
+    /// The created `Variable`
     ///
     /// # Panics
     ///
@@ -401,7 +401,7 @@ impl Model<Solving> {
     ///
     /// # Returns
     ///
-    /// A reference-counted pointer to the new variable.
+    /// The created `Variable`
     ///
     /// # Panics
     ///
@@ -426,10 +426,6 @@ impl Model<Solving> {
     }
 
     /// Returns the current node of the model.
-    ///
-    /// # Panics
-    ///
-    /// This method panics if not called in the `Solving` state, it should only be used from plugins implementations.
     pub fn focus_node(&self) -> Node {
         let scip_node = self.scip.focus_node().expect("Failed to get focus node");
         Node {
@@ -439,10 +435,6 @@ impl Model<Solving> {
     }
 
     /// Creates a new child node of the current node and returns it.
-    ///
-    /// # Panics
-    ///
-    /// This method panics if not called from plugins implementations.
     pub fn create_child(&mut self) -> Node {
         let node_ptr = self
             .scip
@@ -467,7 +459,7 @@ impl Model<Solving> {
     ///
     /// # Returns
     ///
-    /// This function returns a reference-counted smart pointer (`Rc`) to the created `Variable` instance.
+    /// The created `Variable`
     pub fn add_priced_var(
         &mut self,
         lb: f64,
@@ -491,29 +483,28 @@ impl Model<Solving> {
     ///
     /// # Arguments
     ///
-    /// * `cons`      - The constraint to add.
-    /// * `validnode` - The node with the lowest depth for which the constraint is valid.
+    /// * `cons` - The constraint to add (can be built by calling the cons() function).
     ///
     /// # Returns
     ///
-    /// A reference-counted pointer to the new constraint.
+    /// The new constraint
     ///
     /// # Panics
     ///
     /// This method panics if the constraint cannot be created in the current state.
-    pub fn add_cons_local(&mut self, cons_builder: &ConsBuilder) -> Constraint {
-        let vars: Vec<&Variable> = cons_builder.coefs.iter().map(|(var, _)| *var).collect();
-        let coefs: Vec<f64> = cons_builder.coefs.iter().map(|(_, coef)| *coef).collect();
+    pub fn add_cons_local(&mut self, cons: &ConsBuilder) -> Constraint {
+        let vars: Vec<&Variable> = cons.coefs.iter().map(|(var, _)| *var).collect();
+        let coefs: Vec<f64> = cons.coefs.iter().map(|(_, coef)| *coef).collect();
 
         let cons = self
             .scip
             .create_cons(
                 None,
                 vars,
                 &coefs,
-                cons_builder.lhs,
-                cons_builder.rhs,
-                cons_builder.name.unwrap_or(""),
+                cons.lhs,
+                cons.rhs,
+                cons.name.unwrap_or(""),
                 true,
             )
             .expect("Failed to create constraint in state ProblemCreated");
@@ -527,29 +518,29 @@ impl Model<Solving> {
     ///
     /// # Arguments
     ///
-    /// * `cons`      - The constraint to add.
-    /// * `validnode` - The node at which the constraint is valid.
+    /// * `node` - The node to which the constraint should be added.
+    /// * `cons` - The constraint to add.
     ///
     /// # Returns
     ///
-    /// A reference-counted pointer to the new constraint.
+    /// The created `Constraint`.
     ///
     /// # Panics
     ///
     /// This method panics if the constraint cannot be created in the current state.
-    pub fn add_cons_node(&mut self, node: &Node, cons_builder: &ConsBuilder) -> Constraint {
-        let vars: Vec<&Variable> = cons_builder.coefs.iter().map(|(var, _)| *var).collect();
-        let coefs: Vec<f64> = cons_builder.coefs.iter().map(|(_, coef)| *coef).collect();
+    pub fn add_cons_node(&mut self, node: &Node, cons: &ConsBuilder) -> Constraint {
+        let vars: Vec<&Variable> = cons.coefs.iter().map(|(var, _)| *var).collect();
+        let coefs: Vec<f64> = cons.coefs.iter().map(|(_, coef)| *coef).collect();
 
         let cons = self
             .scip
             .create_cons(
                 Some(node),
                 vars,
                 &coefs,
-                cons_builder.lhs,
-                cons_builder.rhs,
-                cons_builder.name.unwrap_or(""),
+                cons.lhs,
+                cons.rhs,
+                cons.name.unwrap_or(""),
                 true,
             )
             .expect("Failed to create constraint in state ProblemCreated");
@@ -566,7 +557,7 @@ impl Model<Solving> {
     /// * `var_prob_id` - The index of the variable in the problem.
     ///
     /// # Returns
-    /// A reference-counted pointer to the variable.
+    /// The `Variable` if it exists, otherwise `None`.
     pub fn var_in_prob(&self, var_prob_id: usize) -> Option<Variable> {
         unsafe {
             ScipPtr::var_from_id(self.scip.raw, var_prob_id).map(|v| Variable {
@@ -1142,7 +1133,7 @@ impl<S: ModelStageProblemOrSolving> ProblemOrSolving for Model<S> {
     ///
     /// # Returns
     ///
-    /// A reference-counted pointer to the new constraint.
+    /// The new `Constraint`.
     ///
     /// # Panics
     ///
@@ -1169,7 +1160,7 @@ impl<S: ModelStageProblemOrSolving> ProblemOrSolving for Model<S> {
     ///
     /// # Returns
     ///
-    /// A reference-counted pointer to the new constraint.
+    /// The created `Constraint`
     ///
     /// # Panics
     ///
@@ -1197,7 +1188,7 @@ impl<S: ModelStageProblemOrSolving> ProblemOrSolving for Model<S> {
     ///
     /// # Returns
     ///
-    /// A reference-counted pointer to the new constraint.
+    /// The created `Constraint`
     ///
     /// # Panics
     ///
@@ -1231,7 +1222,7 @@ impl<S: ModelStageProblemOrSolving> ProblemOrSolving for Model<S> {
     ///
     /// # Returns
     ///
-    /// A reference-counted pointer to the new constraint.
+    /// The created `Constraint`
     ///
     /// # Panics
     ///