Class Solvers.MalitskyPockParams.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Solvers.MalitskyPockParams.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Solvers.MalitskyPockParams.Builder>
      • getDefaultInstanceForType

        public Solvers.MalitskyPockParams getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public Solvers.MalitskyPockParams build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public Solvers.MalitskyPockParams buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • setRepeatedField

        public Solvers.MalitskyPockParams.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                   int index,
                                                                   java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Solvers.MalitskyPockParams.Builder>
      • addRepeatedField

        public Solvers.MalitskyPockParams.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                   java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Solvers.MalitskyPockParams.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Solvers.MalitskyPockParams.Builder>
      • mergeFrom

        public Solvers.MalitskyPockParams.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Solvers.MalitskyPockParams.Builder>
        Throws:
        java.io.IOException
      • hasStepSizeDownscalingFactor

        public boolean hasStepSizeDownscalingFactor()
         At every inner iteration the algorithm can decide to accept the step size
         or to update it to step_size = step_size_downscaling_factor * step_size.
         This parameter should lie between 0 and 1. The default is the value used in
         Malitsky and Pock (2016).
         
        optional double step_size_downscaling_factor = 1 [default = 0.7];
        Specified by:
        hasStepSizeDownscalingFactor in interface Solvers.MalitskyPockParamsOrBuilder
        Returns:
        Whether the stepSizeDownscalingFactor field is set.
      • getStepSizeDownscalingFactor

        public double getStepSizeDownscalingFactor()
         At every inner iteration the algorithm can decide to accept the step size
         or to update it to step_size = step_size_downscaling_factor * step_size.
         This parameter should lie between 0 and 1. The default is the value used in
         Malitsky and Pock (2016).
         
        optional double step_size_downscaling_factor = 1 [default = 0.7];
        Specified by:
        getStepSizeDownscalingFactor in interface Solvers.MalitskyPockParamsOrBuilder
        Returns:
        The stepSizeDownscalingFactor.
      • setStepSizeDownscalingFactor

        public Solvers.MalitskyPockParams.Builder setStepSizeDownscalingFactor​(double value)
         At every inner iteration the algorithm can decide to accept the step size
         or to update it to step_size = step_size_downscaling_factor * step_size.
         This parameter should lie between 0 and 1. The default is the value used in
         Malitsky and Pock (2016).
         
        optional double step_size_downscaling_factor = 1 [default = 0.7];
        Parameters:
        value - The stepSizeDownscalingFactor to set.
        Returns:
        This builder for chaining.
      • clearStepSizeDownscalingFactor

        public Solvers.MalitskyPockParams.Builder clearStepSizeDownscalingFactor()
         At every inner iteration the algorithm can decide to accept the step size
         or to update it to step_size = step_size_downscaling_factor * step_size.
         This parameter should lie between 0 and 1. The default is the value used in
         Malitsky and Pock (2016).
         
        optional double step_size_downscaling_factor = 1 [default = 0.7];
        Returns:
        This builder for chaining.
      • hasLinesearchContractionFactor

        public boolean hasLinesearchContractionFactor()
         Contraction factor used in the linesearch condition of Malitsky and Pock.
         A step size is accepted if primal_weight * primal_stepsize *
         norm(constraint_matrix' * (next_dual - current_dual)) is less
         than linesearch_contraction_factor * norm(next_dual - current_dual).
         The default is the value used in Malitsky and Pock (2016).
         
        optional double linesearch_contraction_factor = 2 [default = 0.99];
        Specified by:
        hasLinesearchContractionFactor in interface Solvers.MalitskyPockParamsOrBuilder
        Returns:
        Whether the linesearchContractionFactor field is set.
      • getLinesearchContractionFactor

        public double getLinesearchContractionFactor()
         Contraction factor used in the linesearch condition of Malitsky and Pock.
         A step size is accepted if primal_weight * primal_stepsize *
         norm(constraint_matrix' * (next_dual - current_dual)) is less
         than linesearch_contraction_factor * norm(next_dual - current_dual).
         The default is the value used in Malitsky and Pock (2016).
         
        optional double linesearch_contraction_factor = 2 [default = 0.99];
        Specified by:
        getLinesearchContractionFactor in interface Solvers.MalitskyPockParamsOrBuilder
        Returns:
        The linesearchContractionFactor.
      • setLinesearchContractionFactor

        public Solvers.MalitskyPockParams.Builder setLinesearchContractionFactor​(double value)
         Contraction factor used in the linesearch condition of Malitsky and Pock.
         A step size is accepted if primal_weight * primal_stepsize *
         norm(constraint_matrix' * (next_dual - current_dual)) is less
         than linesearch_contraction_factor * norm(next_dual - current_dual).
         The default is the value used in Malitsky and Pock (2016).
         
        optional double linesearch_contraction_factor = 2 [default = 0.99];
        Parameters:
        value - The linesearchContractionFactor to set.
        Returns:
        This builder for chaining.
      • clearLinesearchContractionFactor

        public Solvers.MalitskyPockParams.Builder clearLinesearchContractionFactor()
         Contraction factor used in the linesearch condition of Malitsky and Pock.
         A step size is accepted if primal_weight * primal_stepsize *
         norm(constraint_matrix' * (next_dual - current_dual)) is less
         than linesearch_contraction_factor * norm(next_dual - current_dual).
         The default is the value used in Malitsky and Pock (2016).
         
        optional double linesearch_contraction_factor = 2 [default = 0.99];
        Returns:
        This builder for chaining.
      • hasStepSizeInterpolation

        public boolean hasStepSizeInterpolation()
         Malitsky and Pock linesearch rule permits an arbitrary choice of the first
         step size guess within an interval [m, M]. This parameter determines where
         in that interval to pick the step size. In particular, the next stepsize is
         given by m + step_size_interpolation*(M - m). The default is the value used
         in Malitsky and Pock (2016).
         
        optional double step_size_interpolation = 3 [default = 1];
        Specified by:
        hasStepSizeInterpolation in interface Solvers.MalitskyPockParamsOrBuilder
        Returns:
        Whether the stepSizeInterpolation field is set.
      • getStepSizeInterpolation

        public double getStepSizeInterpolation()
         Malitsky and Pock linesearch rule permits an arbitrary choice of the first
         step size guess within an interval [m, M]. This parameter determines where
         in that interval to pick the step size. In particular, the next stepsize is
         given by m + step_size_interpolation*(M - m). The default is the value used
         in Malitsky and Pock (2016).
         
        optional double step_size_interpolation = 3 [default = 1];
        Specified by:
        getStepSizeInterpolation in interface Solvers.MalitskyPockParamsOrBuilder
        Returns:
        The stepSizeInterpolation.
      • setStepSizeInterpolation

        public Solvers.MalitskyPockParams.Builder setStepSizeInterpolation​(double value)
         Malitsky and Pock linesearch rule permits an arbitrary choice of the first
         step size guess within an interval [m, M]. This parameter determines where
         in that interval to pick the step size. In particular, the next stepsize is
         given by m + step_size_interpolation*(M - m). The default is the value used
         in Malitsky and Pock (2016).
         
        optional double step_size_interpolation = 3 [default = 1];
        Parameters:
        value - The stepSizeInterpolation to set.
        Returns:
        This builder for chaining.
      • clearStepSizeInterpolation

        public Solvers.MalitskyPockParams.Builder clearStepSizeInterpolation()
         Malitsky and Pock linesearch rule permits an arbitrary choice of the first
         step size guess within an interval [m, M]. This parameter determines where
         in that interval to pick the step size. In particular, the next stepsize is
         given by m + step_size_interpolation*(M - m). The default is the value used
         in Malitsky and Pock (2016).
         
        optional double step_size_interpolation = 3 [default = 1];
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final Solvers.MalitskyPockParams.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Solvers.MalitskyPockParams.Builder>
      • mergeUnknownFields

        public final Solvers.MalitskyPockParams.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Solvers.MalitskyPockParams.Builder>