如果按契约进行设计,除了成员函数的不变量之外,还需要前置条件和后置条件吗?

发布于 2024-07-30 03:17:52 字数 1272 浏览 4 评论 0原文

据我所知,在 DbC 方法中,前置条件和后置条件附加到函数上。

我想知道这是否也适用于成员函数。

例如,假设我在每个公共函数的开头和结尾处使用不变量,则成员函数将如下所示:

编辑:(清理我的示例)

void Charcoal::LightOnFire() {
  invariant();
  in_LightOnFire();

  StartBurning();    
  m_Status = STATUS_BURNING;
  m_Color = 0xCCCCCC;

  return; // last return in body

  out_LightOnFire();
  invariant();
}

inline void Charcoal::in_LightOnFire() {
  #ifndef _RELEASE_
  assert (m_Status == STATUS_UNLIT);
  assert (m_OnTheGrill == true);
  assert (m_DousedInLighterFluid == true);
  #endif
}

inline void Charcoal::out_LightOnFire() {
  #ifndef _RELEASE_
  assert(m_Status == STATUS_BURNING);
  assert(m_Color == 0xCCCCCC);
  #endif
}

// class invariant
inline void Charcoal::invariant() {
  assert(m_Status == STATUS_UNLIT || m_Status == STATUS_BURNING || m_Status == STATUS_ASHY);
  assert(m_Color == 0x000000 || m_Color == 0xCCCCCC || m_Color == 0xEEEEEE);
}

是否可以仅将前置条件和后置条件与全局/通用函数一起使用并仅使用类内的不变量?

这看起来有点矫枉过正,但也许我的例子很糟糕。

编辑:

后置条件不是只是检查不变量的子集吗?

在上面,我按照 http://www.digitalmars.com/ctg/ 的说明进行操作Contract.html 指出,“当类构造函数完成时、类析构函数开始时、公共成员运行之前以及公共函数完成之后,都会检查不变量。”

谢谢。

I understand that in the DbC method, preconditions and postconditions are attached to a function.

What I'm wondering is if that applies to member functions as well.

For instance, assuming I use invariants at the beginning at end of each public function, a member function will look like this:

edit: (cleaned up my example)

void Charcoal::LightOnFire() {
  invariant();
  in_LightOnFire();

  StartBurning();    
  m_Status = STATUS_BURNING;
  m_Color = 0xCCCCCC;

  return; // last return in body

  out_LightOnFire();
  invariant();
}

inline void Charcoal::in_LightOnFire() {
  #ifndef _RELEASE_
  assert (m_Status == STATUS_UNLIT);
  assert (m_OnTheGrill == true);
  assert (m_DousedInLighterFluid == true);
  #endif
}

inline void Charcoal::out_LightOnFire() {
  #ifndef _RELEASE_
  assert(m_Status == STATUS_BURNING);
  assert(m_Color == 0xCCCCCC);
  #endif
}

// class invariant
inline void Charcoal::invariant() {
  assert(m_Status == STATUS_UNLIT || m_Status == STATUS_BURNING || m_Status == STATUS_ASHY);
  assert(m_Color == 0x000000 || m_Color == 0xCCCCCC || m_Color == 0xEEEEEE);
}

Is it okay to use preconditions and postconditions with global/generic functions only and just use invariants inside classes?

This seems like overkill, but maybe its my example is bad.

edit:

Isn't the postcondition just checking a subset of the invariant?

In the above, I am following the instructions of http://www.digitalmars.com/ctg/contract.html that states, "The invariant is checked when a class constructor completes, at the start of the class destructor, before a public member is run, and after a public function finishes."

Thanks.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(3

墟烟 2024-08-06 03:17:52

将类中的契约限制为不变量并不是最佳选择。

前置条件和后置条件不仅仅是不变量的子集。

不变量、前置条件和后置条件具有非常不同的作用。

不变量确认了对象的内部一致性。它们应该在构造函数的末尾以及每个方法调用之前和之后有效。

前置条件检查对象的状态和参数是否适合方法的执行。前置条件是对不变量的补充。 它们涵盖了参数的检查(对类型本身进行更强的检查,即不为空,> 0,..等),但也可以检查对象内部状态(即对 file.write(" 的调用) hello") 仅当 file.is_rw 和 file.is_open 为 true 时才是有效的调用)。

后置条件检查该方法是否满足其义务后置条件也是对不变量的补充。 当然,在方法执行后,对象的状态必须保持一致,但是后置条件正在检查是否执行了预期的操作(即 list.add(i) 应该得出 list.has(i) 为 true 的结果)并且 list.count = 旧 list.count + 1)。

Restricting the contracts in the classes to invariants is not optimal.

Preconditions and Postconditions are not just a subset of the invariants.

Invariants, Pre-conditions and Post-conditions have very different roles.

Invariants confirms the internal coherence of the object. They should be valid at the end of the constructor and before and after each method call.

Pre-conditions are checking that the status of the object and the arguments are suitable for the execution of the method. Preconditions are complementary to the invariants. They cover the check of the arguments (a stronger check that the type itself, i.e. not null, > 0,.. etc) but also could check for the object internal status (i.e. a call to file.write("hello") is a valid call only if file.is_rw and file.is_open are true).

Post-conditions are cheking that the method satisfied its obligation Post-conditions are also complementary to the invariants. Of course the status of the object has to be coherent after the method execution, but the Post-conditions are checking that the expected action was performed (i.e. list.add(i) should have as consequence that list.has(i) is true and list.count = old list.count + 1).

烏雲後面有陽光 2024-08-06 03:17:52

是的。

C 类的不变性是其所有实例(对象)的共同属性。 当且仅当对象处于语义上有效的状态时,不变量的计算结果为 true。

电梯的不变量可能包含诸如 ASSERT(IsStopped() || Door.IsClosed()) 之类的信息,因为电梯处于与停止不同的状态(例如上行)是无效的并且门开着。

相反,诸如 MoveTo(int flat) 之类的成员函数可能会将 CurrentFlat()==flat 作为后置条件; 因为在调用 MoveTo(6) 后,当前单位为 6。同样,它可能以 IsStopped() 作为前提条件,因为(取决于设计)您可以如果电梯已经在移动,则不要调用函数 MoveTo。 首先,您必须查询其状态,确保其已停止,然后调用该函数。

当然,我可能过于简单化了电梯的工作原理。

无论如何,一般来说,前置条件和后置条件作为不变条件是没有意义的; 电梯无需位于 6 楼即可处于有效状态。

可以在这里找到更简洁的示例:拦截和属性:Sasha Goldshtein 的合同设计示例

Yes.

Class C's invariant is a common property of all of its instances (objects). The invariant evaluates to true if and only if the object is in a semantically valid state.

An elevator's invariant may contain information such as ASSERT(IsStopped() || Door.IsClosed()), because it is invalid for an elevator to be in a state different than stopped (say, going up) and with the door open.

In contrast, a member function such as MoveTo(int flat) may have CurrentFlat()==flat as a postcondition; because after a call to MoveTo(6) the current flat is 6. Similarly, it may have IsStopped() as a precondition, because (depending on the design) you can't invoke function MoveTo if the elevator is already moving. First, you have to query its state, make sure that it is stopped, and then call the function.

Of course I may be totally oversimplifying how an elevator works.

In any case, the preconditions and postconditions will make no sense, in general, as invariant conditions; an elevator doesn't need to be at floor 6 to be in a valid state.

A more concise example can be found here: Interception and Attributes: A Design-By-Contract Sample by Sasha Goldshtein.

べ映画 2024-08-06 03:17:52

嗯,不变量的要点是它描述了对象在任何时候都是正确的东西。 在这种情况下,烤架上有东西,或者没有(介于两者之间)。 它们通常描述对象整个状态的属性。

前置条件和后置条件描述了方法执行之前和之后正确的事情,并且仅涉及该方法应该触及的状态。 这大概与对象的状态不同。 前置条件和后置条件可能被认为是描述一个方法的足迹——只是它需要什么,只是它触及什么。

因此,对于具体问题,这些想法会做不同的事情,所以你很可能两者都想要。 您当然不能只使用不变量而不是前置条件和后置条件 - 在这种情况下,对象不变量的一部分是“有东西在烤架上或没有”,但 lightOnFire 的前提条件需要知道该项目在烤架上。 你永远无法从对象不变量中推断出这一点。 确实,从前置条件和后置条件以及已知的开始状态,您可以(假设对象结构仅通过方法可变,并且前置条件和后置条件描述了所有环境变化),推断出对象不变性。 然而,这可能很复杂,当您“用语言”陈述事物时,提供两者会更容易。

当然,在变体中声明布尔项是 true 或 false 有点毫无意义 - 类型系统确保了这一点。

Well, the point of an invariant is that it describes something that's true of the object at all times. In this case, something is on the grill, or not (nothing in between). They normally describe a property of the entire state of the object.

Pre and post conditions describe things that are true just before a method executes, and just after, and will concern just the state that should have been touched by the method. This is different, presumably, from the state of the object. Pre and post conditions might be thought of as describing the footprint of a method - just what it needed, just what it touched.

So, to the specific question, the ideas do different things, so you may well want both. You certainly cannot just use invariants instead of pre and post conditions - in this instance, part of the object invariant is "Something is on the grill or not", but the precondition of lightOnFire needs to know that the item is on the grill. You can never infer this from the object invariant. It is true that from pre and postconditions and a known start state, you can (assuming that the objects structure is only mutable through methods, and the pre and post conditions describe all the environmental changes), infer an object invariant. However, this can be complex, and when you're stating things "in language", it's easier to just provide both.

Of course, doing in variants that state a boolean item is either true or false is a bit pointless - the type system ensures that.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文